WriterTarget (LogKit API)
Keywords: org.apache.log.output.io.WriterTarget,WriterTarget class

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.log.output.io
Class WriterTarget

    java.lang.Object
      |
      +--org.apache.log.output.AbstractTarget
            |
            +--org.apache.log.output.AbstractOutputTarget
                  |
                  +--org.apache.log.output.io.WriterTarget

All Implemented Interfaces:
  ErrorAware, LogTarget

Direct Known Subclasses:
  DefaultOutputLogTarget

public class WriterTarget
extends AbstractOutputTarget

This target outputs to a writer.

Author:
  Peter Donald

Field Summary
`protected Writer` | `m_output` Deprecated. Accessing this variable in subclasses is no longer supported and will become private in the future.

Fields inherited from class org.apache.log.output.AbstractOutputTarget
`m_formatter`

Constructor Summary
`WriterTarget(Writer writer, Formatter formatter)` Construct target with a specific writer and formatter.

Method Summary
`void` | `close()` Shutdown target.
`protected void` | `setWriter(Writer writer)` Set the writer.
`protected void` | `shutdownWriter()` Shutdown Writer.
`protected void` | `write(String data)` Concrete implementation of output that writes out to underlying writer.

Methods inherited from class org.apache.log.output.AbstractOutputTarget
`doProcessEvent, getFormatter, open, output, setFormatter`

Methods inherited from class org.apache.log.output.AbstractTarget
`error, getErrorHandler, isOpen, processEvent, setErrorHandler`

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

Field Detail

### m_output

    protected Writer m_output

  Deprecated. Accessing this variable in subclasses is no longer supported and will become private in the future.

Constructor Detail

### WriterTarget

    public WriterTarget(Writer writer,
                        Formatter formatter)

  Construct target with a specific writer and formatter.

Parameters:
  `writer` - the writer
  `formatter` - the formatter

Method Detail

### setWriter

    protected void setWriter(Writer writer)

  Set the writer. Close down writer and write tail if appropriate.

  Parameters:
    `writer` - the new writer

### write

    protected void write(String data)

  Concrete implementation of output that writes out to underlying writer.

  Overrides:
    `write` in class `AbstractOutputTarget`
  Parameters:
    `data` - the data to output

### close

    public void close()

  Shutdown target. Attempting to write to target after close() will cause errors to be logged.

  Overrides:
    `close` in class `AbstractOutputTarget`

### shutdownWriter

    protected void shutdownWriter()

  Shutdown Writer.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001 Apache Jakarta Project. All Rights Reserved.