LogWriter (Apache OODT 0.7 API)

java.lang.Object
- java.io.Writer
- - org.apache.oodt.commons.io.LogWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable
```
public class LogWriter
extends Writer
```
A writer for log messages. Objects of this class let you write messages into the logging facility. You get these objects by calling one of the get methods of class Log and use it as you would use a PrintWriter. This class automatically flushes a message to the logging facility whenever you call one of the println methods, or flush(). It prints all values and objects using the platform's default character encoding.
Note that the println methods of this class don't actually write any line separation characters into the log. Log listeners will want the messages without such characters anyway, so this is the correct behavior.

Author:

Kelly

See Also:
Log

Field Summary
- Fields inherited from class java.io.Writer
  lock

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close the log writer.
`void`	`flush()` Flush the log writer.
`boolean`	`isFlushed()` Are we flushed yet?
`void`	`print(boolean b)` Print a boolean value.
`void`	`print(char c)` Print a character.
`void`	`print(char[] a)` Print an array of characters.
`void`	`print(double d)` Print a double-precision floating-point number.
`void`	`print(float f)` Print a floating-point number.
`void`	`print(int i)` Print an integer.
`void`	`print(long l)` Print a long integer.
`void`	`print(Object obj)` Print an object.
`void`	`print(String s)` Print a string.
`void`	`println()` Terminate the current message.
`void`	`println(boolean b)` Print a boolean value and terminate the message.
`void`	`println(char c)` Print a character value and terminate the message.
`void`	`println(char[] a)` Print a character array and terminate the message.
`void`	`println(double d)` Print a double-precision floating-point value and terminate the message.
`void`	`println(float f)` Print a floating-point value and terminate the message.
`void`	`println(int i)` Print an integer value and terminate the message.
`void`	`println(long l)` Print a long integer value and terminate the message.
`void`	`println(Object obj)` Print an Object and terminate the message.
`void`	`println(String s)` Print a String and terminate the message.
`void`	`println(Throwable t)`
`void`	`write(char[] array)` Write an array of characters.
`void`	`write(char[] array, int offset, int length)` Write a portion of an array of characters.
`void`	`write(int c)` Write a single character.
`void`	`write(String string)` Write a string.
`void`	`write(String string, int offset, int length)` Write a portion of a string.

Methods inherited from class java.io.Writer
append, append, append

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - write
```
public void write(int c)
```
    Write a single character. This writes a single character (the low order 16 bits of c) to the log writer. The character isn't flushed to the logging facility until you call one of the println methods or flush().
    
    Overrides:
    
    write in class Writer
    
    Parameters:
    c - The character to write.
  - write
```
public void write(char[] array,
         int offset,
         int length)
```
    Write a portion of an array of characters. This writes the given character array starting at offset and going for length bytes.
    
    Specified by:
    
    write in class Writer
    
    Parameters:
    array - The character array to write.
    offset - Where in the array to get characters to write.
    length - How many characters to write.
  - write
```
public void write(char[] array)
```
    Write an array of characters. This writes the entire given array.
    
    Overrides:
    
    write in class Writer
    
    Parameters:
    array - Array of characters to write.
  - write
```
public void write(String string,
         int offset,
         int length)
```
    Write a portion of a string. This writes length characters from the given string, starting offset characters into it.
    
    Overrides:
    
    write in class Writer
    
    Parameters:
    string - The string to write.
    offset - Where in the string to get characters to write.
    length - How many characters to write.
  - write
```
public void write(String string)
```
    Write a string. This writes the entire given string.
    
    Overrides:
    
    write in class Writer
    
    Parameters:
    string - String to write.
  - flush
```
public void flush()
```
    Flush the log writer. This sends any text sent to the writer on its way to the logging facility, and beyond.
    
    Specified by:
    
    flush in interface Flushable
    
    Specified by:
    
    flush in class Writer
  - close
```
public void close()
```
    Close the log writer.
    This flushes any remaining text to the logging facility and then shuts down the log writer. You can't use it again after that (but closing a previously closed log writer is OK).
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in class Writer
  - print
```
public void print(boolean b)
```
    Print a boolean value. This prints a boolean value ("true" or "false") into the log.
    
    Parameters:
    b - The boolean to print.
  - print
```
public void print(char c)
```
    Print a character. The character is translated into one or more bytes according to the platform's default character encoding.
    
    Parameters:
    c - The char to print.
  - print
```
public void print(int i)
```
    Print an integer.
    
    Parameters:
    i - The int to print.
  - print
```
public void print(long l)
```
    Print a long integer.
    
    Parameters:
    l - The long to print.
  - print
```
public void print(float f)
```
    Print a floating-point number.
    
    Parameters:
    f - The float to print.
  - print
```
public void print(double d)
```
    Print a double-precision floating-point number.
    
    Parameters:
    d - The double to print.
  - print
```
public void print(char[] a)
```
    Print an array of characters.
    
    Parameters:
    a - The array of chars to print.
  - print
```
public void print(String s)
```
    Print a string. If the argument is null then the string "null" is printed.
    
    Parameters:
    s - The String to print.
  - print
```
public void print(Object obj)
```
    Print an object.
    
    Parameters:
    obj - The Object to print.
  - println
```
public void println(boolean b)
```
    Print a boolean value and terminate the message. This prints a boolean into the log, and flushes the message to the logging facility.
    
    Parameters:
    b - The boolean to print.
  - println
```
public void println(char c)
```
    Print a character value and terminate the message. This prints a character into the log, and flushes the message to the logging facility.
    
    Parameters:
    c - The char to print.
  - println
```
public void println(int i)
```
    Print an integer value and terminate the message. This prints an integer into the log, and flushes the message to the logging facility.
    
    Parameters:
    i - The int to print.
  - println
```
public void println(long l)
```
    Print a long integer value and terminate the message. This prints a long integer into the log, and flushes the message to the logging facility.
    
    Parameters:
    l - The long to print.
  - println
```
public void println(float f)
```
    Print a floating-point value and terminate the message. This prints a floating-point value into the log, and flushes the message to the logging facility.
    
    Parameters:
    f - The float to print.
  - println
```
public void println(double d)
```
    Print a double-precision floating-point value and terminate the message. This prints a double-precision floating-point into the log, and flushes the message to the logging facility.
    
    Parameters:
    d - The double to print.
  - println
```
public void println(char[] a)
```
    Print a character array and terminate the message. This prints a character array into the log, and flushes the message to the logging facility.
    
    Parameters:
    a - The array of chars to print.
  - println
```
public void println(String s)
```
    Print a String and terminate the message. This prints a String into the log, and flushes the message to the logging facility.
    
    Parameters:
    s - The String to print.
  - println
```
public void println(Throwable t)
```
  - println
```
public void println(Object obj)
```
    Print an Object and terminate the message. This prints an Object into the log, and flushes the message to the logging facility.
    
    Parameters:
    obj - The Object to print.
  - println
```
public void println()
```
    Terminate the current message. This terminates any message text built up and sends it to the logging facility.
  - isFlushed
```
public boolean isFlushed()
```
    Are we flushed yet?
    
    Returns:
    True if flushed, false otherwise.

Class LogWriter

Field Summary

Fields inherited from class java.io.Writer

Method Summary

Methods inherited from class java.io.Writer

Methods inherited from class java.lang.Object

Method Detail

write

write

write

write

write

flush

close

print

print

print

print

print

print

print

print

print

println

println

println

println

println

println

println

println

println

println

println

isFlushed