JBoss Log Manager 3.1.2.Final · org.jboss.logmanager.handlers.WriterHandler

Modifier and Type	Field and Description
private volatile boolean	checkHeadEncoding
private volatile boolean	checkTailEncoding
private Writer	writer

Access	Constructor and Description
public	WriterHandler() Construct a new instance.

Method Summary

Modifier and Type	Method and Description
public void	close() Overrides org.jboss.logmanager.ExtHandler.close. Implements java.lang.AutoCloseable.close. Close this logger.
protected void	doPublish(final ExtLogRecord the log record to publish record) Overrides org.jboss.logmanager.ExtHandler.doPublish. Do the actual work of publication; the record will have been filtered already.
public void	flush() Overrides org.jboss.logmanager.ExtHandler.flush. Implements java.io.Flushable.flush. Flush this logger.
pack-priv Writer	getWriter()
public boolean	Returns: `true` to check and report head encoding problems, or `false` to ignore them isCheckHeadEncoding() Determine whether head encoding checking is turned on.
public boolean	Returns: `true` to check and report tail encoding problems, or `false` to ignore them isCheckTailEncoding() Determine whether tail encoding checking is turned on.
protected void	preWrite(final ExtLogRecord the record about to be logged record) Execute any pre-write policy, such as file rotation.
protected void	safeClose(Closeable the resource c) Safely close the resource, reporting an error if the close fails.
pack-priv void	safeFlush(Flushable f)
public WriterHandler	Returns: this handler setCheckHeadEncoding(boolean `true` to check and report head encoding problems, or `false` to ignore them checkHeadEncoding) Establish whether head encoding checking is turned on.
public WriterHandler	Returns: this handler setCheckTailEncoding(boolean `true` to check and report tail encoding problems, or `false` to ignore them checkTailEncoding) Establish whether tail encoding checking is turned on.
public void	setWriter(final Writer the new writer, or `null` to disable logging writer) Set the writer.
private void	writeHead(final Writer writer)
private void	writeTail(final Writer writer)

checkHeadEncoding	back to summary
private volatile boolean checkHeadEncoding

checkTailEncoding	back to summary
private volatile boolean checkTailEncoding

writer	back to summary
private Writer writer

WriterHandler	back to summary
public WriterHandler() Construct a new instance.

Method Detail

close	back to summary
public void close() throws SecurityException Overrides org.jboss.logmanager.ExtHandler.close. Implements java.lang.AutoCloseable.close. Close this logger. Exceptions SecurityException: if the caller does not have sufficient permission

back to summary

public void close() throws SecurityException

Overrides org.jboss.logmanager.ExtHandler.close.

Implements java.lang.AutoCloseable.close.

Close this logger.

Exceptions

SecurityException:: if the caller does not have sufficient permission

doPublish back to summary

doPublish	back to summary
protected void doPublish(final ExtLogRecord record) Overrides org.jboss.logmanager.ExtHandler.doPublish. Doc from org.jboss.logmanager.ExtHandler.doPublish. Do the actual work of publication; the record will have been filtered already. The default implementation does nothing except to flush if the `autoFlush` property is set to `true`; if this behavior is to be preserved in a subclass then this method should be called after the record is physically written. Parameters record:ExtLogRecord the log record to publish

protected void doPublish(final ExtLogRecord record)

Overrides org.jboss.logmanager.ExtHandler.doPublish.

Doc from org.jboss.logmanager.ExtHandler.doPublish.

Do the actual work of publication; the record will have been filtered already. The default implementation does nothing except to flush if the autoFlush property is set to true; if this behavior is to be preserved in a subclass then this method should be called after the record is physically written.

Parameters

record:ExtLogRecord: the log record to publish

flush	back to summary
public void flush() Overrides org.jboss.logmanager.ExtHandler.flush. Implements java.io.Flushable.flush. Flush this logger.

flush

back to summary

public void flush()

Overrides org.jboss.logmanager.ExtHandler.flush.

Implements java.io.Flushable.flush.

Flush this logger.

getWriter	back to summary
pack-priv Writer getWriter()

isCheckHeadEncoding back to summary

isCheckHeadEncoding	back to summary
public boolean isCheckHeadEncoding() Determine whether head encoding checking is turned on. Returns:boolean `true` to check and report head encoding problems, or `false` to ignore them

public boolean isCheckHeadEncoding()

Determine whether head encoding checking is turned on.

Returns:boolean: true to check and report head encoding problems, or false to ignore them

isCheckTailEncoding back to summary

isCheckTailEncoding	back to summary
public boolean isCheckTailEncoding() Determine whether tail encoding checking is turned on. Returns:boolean `true` to check and report tail encoding problems, or `false` to ignore them

public boolean isCheckTailEncoding()

Determine whether tail encoding checking is turned on.

Returns:boolean: true to check and report tail encoding problems, or false to ignore them

preWrite	back to summary
protected void preWrite(final ExtLogRecord record) Execute any pre-write policy, such as file rotation. The write lock is held during this method, so make it quick. The default implementation does nothing. Parameters record:ExtLogRecord the record about to be logged

preWrite

back to summary

protected void preWrite(final ExtLogRecord record)

Execute any pre-write policy, such as file rotation. The write lock is held during this method, so make it quick. The default implementation does nothing.

Parameters

record:ExtLogRecord: the record about to be logged

safeClose	back to summary
protected void safeClose(Closeable c) Safely close the resource, reporting an error if the close fails. Parameters c:Closeable the resource

safeClose

back to summary

protected void safeClose(Closeable c)

Safely close the resource, reporting an error if the close fails.

Parameters

c:Closeable: the resource

safeFlush	back to summary
pack-priv void safeFlush(Flushable f)

setCheckHeadEncoding back to summary

setCheckHeadEncoding	back to summary
public WriterHandler setCheckHeadEncoding(boolean checkHeadEncoding) Establish whether head encoding checking is turned on. Parameters checkHeadEncoding:boolean `true` to check and report head encoding problems, or `false` to ignore them Returns:WriterHandler this handler

public WriterHandler setCheckHeadEncoding(boolean checkHeadEncoding)

Establish whether head encoding checking is turned on.

Parameters

checkHeadEncoding:boolean: true to check and report head encoding problems, or false to ignore them

Returns:WriterHandler

this handler

setCheckTailEncoding back to summary

setCheckTailEncoding	back to summary
public WriterHandler setCheckTailEncoding(boolean checkTailEncoding) Establish whether tail encoding checking is turned on. Parameters checkTailEncoding:boolean `true` to check and report tail encoding problems, or `false` to ignore them Returns:WriterHandler this handler

public WriterHandler setCheckTailEncoding(boolean checkTailEncoding)

Establish whether tail encoding checking is turned on.

Parameters

checkTailEncoding:boolean: true to check and report tail encoding problems, or false to ignore them

Returns:WriterHandler

this handler

setWriter back to summary

setWriter	back to summary
public void setWriter(final Writer writer) Set the writer. The writer will then belong to this handler; when the handler is closed or a new writer is set, this writer will be closed. Parameters writer:Writer the new writer, or `null` to disable logging

public void setWriter(final Writer writer)

Set the writer. The writer will then belong to this handler; when the handler is closed or a new writer is set, this writer will be closed.

Parameters

writer:Writer: the new writer, or null to disable logging

writeHead	back to summary
private void writeHead(final Writer writer)

writeTail	back to summary
private void writeTail(final Writer writer)

public Class WriterHandler

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail