- java.lang.Object
- 
- java.util.logging.Handler
- 
- java.util.logging.StreamHandler
 
 
- 
- Direct Known Subclasses:
- ConsoleHandler,- FileHandler,- SocketHandler
 
 public class StreamHandler extends Handler Stream based loggingHandler.This is primarily intended as a base class or support class to be used in implementing other logging Handlers.LogRecordsare published to a givenjava.io.OutputStream.Configuration: By default each StreamHandleris initialized using the followingLogManagerconfiguration properties where<handler-name>refers to the fully-qualified class name of the handler. If properties are not defined (or have invalid values) then the specified default values are used.-    <handler-name>.level
        specifies the default level for the Handler(defaults toLevel.INFO).
-    <handler-name>.filter
        specifies the name of a Filterclass to use (defaults to noFilter).
-    <handler-name>.formatter
        specifies the name of a Formatterclass to use (defaults tojava.util.logging.SimpleFormatter).
- <handler-name>.encoding the name of the character set encoding to use (defaults to the default platform encoding).
 For example, the properties for StreamHandlerwould be:- java.util.logging.StreamHandler.level=INFO
- java.util.logging.StreamHandler.formatter=java.util.logging.SimpleFormatter
 For a custom handler, e.g. com.foo.MyHandler, the properties would be: - com.foo.MyHandler.level=INFO
- com.foo.MyHandler.formatter=java.util.logging.SimpleFormatter
 - Since:
- 1.4
 
- 
- 
Constructor SummaryConstructors Constructor Description StreamHandler()Create aStreamHandler, with no current output stream.StreamHandler(OutputStream out, Formatter formatter)Create aStreamHandlerwith a givenFormatterand output stream.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclose()Close the current output stream.voidflush()Flush any buffered messages.booleanisLoggable(LogRecord record)Check if thisHandlerwould actually log a givenLogRecord.voidpublish(LogRecord record)Format and publish aLogRecord.voidsetEncoding(String encoding)Set (or change) the character encoding used by thisHandler.protected voidsetOutputStream(OutputStream out)Change the output stream.- 
Methods declared in class java.util.logging.HandlergetEncoding, getErrorManager, getFilter, getFormatter, getLevel, reportError, setErrorManager, setFilter, setFormatter, setLevel
 
- 
 
- 
- 
- 
Constructor Detail- 
StreamHandlerpublic StreamHandler() Create aStreamHandler, with no current output stream.
 - 
StreamHandlerpublic StreamHandler(OutputStream out, Formatter formatter) Create aStreamHandlerwith a givenFormatterand output stream.- Parameters:
- out- the target output stream
- formatter- Formatter to be used to format output
 
 
- 
 - 
Method Detail- 
setOutputStreamprotected 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.- Parameters:
- out- New output stream. May not be null.
- Throws:
- SecurityException- if a security manager exists and if the caller does not have- LoggingPermission("control").
 
 - 
setEncodingpublic void setEncoding(String encoding) throws SecurityException, UnsupportedEncodingException Set (or change) the character encoding used by thisHandler.The encoding should be set before any LogRecordsare written to theHandler.- Overrides:
- setEncodingin class- Handler
- Parameters:
- encoding- The name of a supported character encoding. May be null, to indicate the default platform encoding.
- Throws:
- SecurityException- if a security manager exists and if the caller does not have- LoggingPermission("control").
- UnsupportedEncodingException- if the named encoding is not supported.
 
 - 
publishpublic void publish(LogRecord record) Format and publish aLogRecord.The StreamHandlerfirst checks if there is anOutputStreamand if the givenLogRecordhas at least the required log level. If not it silently returns. If so, it calls any associatedFilterto check if the record should be published. If so, it calls itsFormatterto format the record and then writes the result to the current output stream.If this is the first LogRecordto be written to a givenOutputStream, theFormatter's "head" string is written to the stream before theLogRecordis written.
 - 
isLoggablepublic boolean isLoggable(LogRecord record) Check if thisHandlerwould actually log a givenLogRecord.This method checks if the LogRecordhas an appropriate level and whether it satisfies anyFilter. It will also return false if no output stream has been assigned yet or the LogRecord is null.- Overrides:
- isLoggablein class- Handler
- Parameters:
- record- a- LogRecord(may be null).
- Returns:
- true if the LogRecordwould be logged.
 
 - 
closepublic void close() throws SecurityExceptionClose the current output stream.The Formatter's "tail" string is written to the stream before it is closed. In addition, if theFormatter's "head" string has not yet been written to the stream, it will be written before the "tail" string.- Specified by:
- closein class- Handler
- Throws:
- SecurityException- if a security manager exists and if the caller does not have LoggingPermission("control").
 
 
- 
 
-