Save This Page
Home » openjdk-7 » java » util » logging » [javadoc | source]
java.util.logging
public class: StreamHandler [javadoc | source]
java.lang.Object
   java.util.logging.Handler
      java.util.logging.StreamHandler

Direct Known Subclasses:
    ConsoleHandler, FileHandler, SocketHandler

Stream based logging Handler.

This is primarily intended as a base class or support class to be used in implementing other logging Handlers.

LogRecords are published to a given java.io.OutputStream.

Configuration: By default each StreamHandler is initialized using the following LogManager configuration properties. If properties are not defined (or have invalid values) then the specified default values are used.

Fields inherited from java.util.logging.Handler:
sealed
Constructor:
 public StreamHandler() 
 public StreamHandler(OutputStream out,
    Formatter formatter) 
    Create a StreamHandler with a given Formatter and output stream.

    Parameters:
    out - the target output stream
    formatter - Formatter to be used to format output
Method from java.util.logging.StreamHandler Summary:
close,   flush,   isLoggable,   publish,   setEncoding,   setOutputStream
Methods from java.util.logging.Handler:
checkAccess,   close,   flush,   getEncoding,   getErrorManager,   getFilter,   getFormatter,   getLevel,   isLoggable,   publish,   reportError,   setEncoding,   setErrorManager,   setFilter,   setFormatter,   setLevel
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.util.logging.StreamHandler Detail:
 public synchronized  void close() throws SecurityException 
    Close the current output stream.

    The Formatter's "tail" string is written to the stream before it is closed. In addition, if the Formatter's "head" string has not yet been written to the stream, it will be written before the "tail" string.

 public synchronized  void flush() 
    Flush any buffered messages.
 public boolean isLoggable(LogRecord record) 
    Check if this Handler would actually log a given LogRecord.

    This method checks if the LogRecord has an appropriate level and whether it satisfies any Filter. It will also return false if no output stream has been assigned yet or the LogRecord is Null.

 public synchronized  void publish(LogRecord record) 
    Format and publish a LogRecord.

    The StreamHandler first checks if there is an OutputStream and if the given LogRecord has at least the required log level. If not it silently returns. If so, it calls any associated Filter to check if the record should be published. If so, it calls its Formatter to format the record and then writes the result to the current output stream.

    If this is the first LogRecord to be written to a given OutputStream, the Formatter's "head" string is written to the stream before the LogRecord is written.

 public  void setEncoding(String encoding) throws SecurityException, UnsupportedEncodingException 
    Set (or change) the character encoding used by this Handler.

    The encoding should be set before any LogRecords are written to the Handler.

 protected synchronized  void setOutputStream(OutputStream out) throws SecurityException 
    Change the output stream.

    If there is a current output stream then the Formatter's tail string is written and the stream is flushed and closed. Then the output stream is replaced with the new output stream.