Package org.apache.log.output.io
Class StreamTarget
- java.lang.Object
-
- org.apache.log.output.AbstractTarget
-
- org.apache.log.output.AbstractOutputTarget
-
- org.apache.log.output.io.StreamTarget
-
- All Implemented Interfaces:
ErrorAware
,LogTarget
,Closeable
- Direct Known Subclasses:
FileTarget
public class StreamTarget extends AbstractOutputTarget
A basic target that writes to an OutputStream.
-
-
Field Summary
Fields Modifier and Type Field Description private java.lang.String
m_encoding
The encoding to use when creating byte array for string, may be null.private java.io.OutputStream
m_outputStream
OutputStream we are writing to.
-
Constructor Summary
Constructors Constructor Description StreamTarget(java.io.OutputStream outputStream, Formatter formatter)
Constructor that writes to a stream and uses a particular formatter.StreamTarget(java.io.OutputStream outputStream, Formatter formatter, java.lang.String encoding)
Constructor that writes to a stream and uses a particular formatter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Shutdown target.protected void
setOutputStream(java.io.OutputStream outputStream)
Set the output stream.protected void
shutdownStream()
Shutdown output stream.protected void
write(java.lang.String data)
Abstract method that will output event.-
Methods inherited from class org.apache.log.output.AbstractOutputTarget
doProcessEvent, getFormatter, open
-
Methods inherited from class org.apache.log.output.AbstractTarget
getErrorHandler, isOpen, processEvent, setErrorHandler
-
-
-
-
Constructor Detail
-
StreamTarget
public StreamTarget(java.io.OutputStream outputStream, Formatter formatter, java.lang.String encoding)
Constructor that writes to a stream and uses a particular formatter.- Parameters:
outputStream
- the OutputStream to write toformatter
- the Formatter to useencoding
- Desired encoding to use when writing to the log, null implies the default system encoding.
-
StreamTarget
public StreamTarget(java.io.OutputStream outputStream, Formatter formatter)
Constructor that writes to a stream and uses a particular formatter.- Parameters:
outputStream
- the OutputStream to write toformatter
- the Formatter to use
-
-
Method Detail
-
setOutputStream
protected void setOutputStream(java.io.OutputStream outputStream)
Set the output stream. Close down old stream and write tail if appropriate.- Parameters:
outputStream
- the new OutputStream
-
write
protected void write(java.lang.String data)
Abstract method that will output event.- Overrides:
write
in classAbstractOutputTarget
- Parameters:
data
- the data to be output
-
close
public void close()
Shutdown target. Attempting to write to target after close() will cause errors to be logged.- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classAbstractOutputTarget
-
shutdownStream
protected void shutdownStream()
Shutdown output stream.
-
-