flex.messaging.log

Class LineFormattedTarget

java.lang.Object

flex.messaging.log.AbstractTarget

flex.messaging.log.LineFormattedTarget

All Implemented Interfaces:

Target

Direct Known Subclasses:

ConsoleTarget

public class LineFormattedTarget
extends AbstractTarget

Field Summary

Fields

Modifier and Type	Field and Description
protected DateFormat	dateFormater The formatter to write the date as part of the logging statement.
protected boolean	includeCategory Indicates if the category for this target should added to the trace.
protected boolean	includeDate Indicates if the date should be added to the trace.
protected boolean	includeLevel Indicates if the level for the event should added to the trace.
protected boolean	includeTime Indicates if the time should be added to the trace.
protected String	prefix A prefix to prepend onto each logged message.
protected DateFormat	timeFormatter The formatter to write the time as part of the logging statement.

Fields inherited from class flex.messaging.log.AbstractTarget

filters, id, level, loggerCount

Constructor Summary

Constructors

Constructor and Description
LineFormattedTarget() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getPrefix() Returns prefix property.
void	initialize(String id, ConfigMap properties) Initializes the target with id and properties.
protected void	internalLog(String message) Descendants of this class should override this method to direct the specified message to the desired output.
boolean	isIncludeCategory() Returns includeCategory property.
boolean	isIncludeDate() Returns includeDate property.
boolean	isIncludeLevel() Returns includeLevel property.
boolean	isIncludeTime() Returns includeTime property.
void	logEvent(LogEvent event) This method handles a LogEvent from an associated logger.
void	setIncludeCategory(boolean includeCategory) Sets includeCategory property.
void	setIncludeDate(boolean includeDate) Sets includeDate property.
void	setIncludeLevel(boolean includeLevel) Sets includeLevel property.
void	setIncludeTime(boolean includeTime) Sets includeTime property.
void	setPrefix(String prefix) Sets prefix property.

Methods inherited from class flex.messaging.log.AbstractTarget

addFilter, addLogger, containsFilter, getFilters, getId, getLevel, removeFilter, removeLogger, setFilters, setLevel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

includeDate

protected boolean includeDate

Indicates if the date should be added to the trace.

includeTime

protected boolean includeTime

Indicates if the time should be added to the trace.

includeLevel

protected boolean includeLevel

Indicates if the level for the event should added to the trace.

includeCategory

protected boolean includeCategory

Indicates if the category for this target should added to the trace.

prefix

protected String prefix

A prefix to prepend onto each logged message.

dateFormater

protected DateFormat dateFormater

The formatter to write the date as part of the logging statement. Defaults to MM/dd/yyyy format.

timeFormatter

protected DateFormat timeFormatter

The formatter to write the time as part of the logging statement. Defaults to HH:mm:ss.SSS format.

Constructor Detail

LineFormattedTarget

public LineFormattedTarget()

Default constructor.

Method Detail

initialize

public void initialize(String id,
              ConfigMap properties)

Initializes the target with id and properties. Subclasses can overwrite.

Specified by:

initialize in interface Target

Overrides:

initialize in class AbstractTarget

Parameters:

id - id for the target which is ignored.

properties - ConfigMap of properties for the target.

isIncludeCategory

public boolean isIncludeCategory()

Returns includeCategory property.

Returns:

true if category is included; false otherwise.

setIncludeCategory

public void setIncludeCategory(boolean includeCategory)

Sets includeCategory property.

Parameters:

includeCategory - the include category

isIncludeDate

public boolean isIncludeDate()

Returns includeDate property.

Returns:

true if date is included; false otherwise.

setIncludeDate

public void setIncludeDate(boolean includeDate)

Sets includeDate property.

Parameters:

includeDate - the include date

isIncludeLevel

public boolean isIncludeLevel()

Returns includeLevel property.

Returns:

true if level is included; false otherwise.

setIncludeLevel

public void setIncludeLevel(boolean includeLevel)

Sets includeLevel property.

Parameters:

includeLevel - the include level

isIncludeTime

public boolean isIncludeTime()

Returns includeTime property.

Returns:

true if time is included; false otherwise.

setIncludeTime

public void setIncludeTime(boolean includeTime)

Sets includeTime property.

Parameters:

includeTime - the include time

getPrefix

public String getPrefix()

Returns prefix property.

Returns:

The prefix for log messages.

setPrefix

public void setPrefix(String prefix)

Sets prefix property.

Parameters:

prefix - the prefix string

logEvent

public void logEvent(LogEvent event)

This method handles a LogEvent from an associated logger. A target uses this method to translate the event into the appropriate format for transmission, storage, or display. This method will be called only if the event's level is in range of the target's level.

Parameters:

event - the log event

internalLog

protected void internalLog(String message)

Descendants of this class should override this method to direct the specified message to the desired output.

Parameters:

message - String containing preprocessed log message which may include time, date, category, etc. based on property settings, such as includeDate, includeCategory, etc.