Class TimestampAction

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.joran.action.Action

ch.qos.logback.core.joran.action.BaseModelAction

ch.qos.logback.core.joran.action.TimestampAction

All Implemented Interfaces:

ContextAware

public class TimestampAction
extends BaseModelAction

Given a key and a date-and-time pattern, puts a property to the context, with the specified key and value equal to the current time in the format corresponding to the specified date-and-time pattern.

Author:

Ceki Gülcü

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_PATTERN_ATTRIBUTE
static final String	TIME_REFERENCE_ATTRIBUTE

Fields inherited from class Action

ACTION_CLASS_ATTRIBUTE, CLASS_ATTRIBUTE, FILE_ATTRIBUTE, KEY_ATTRIBUTE, NAME_ATTRIBUTE, PATTERN_ATTRIBUTE, SCOPE_ATTRIBUTE, VALUE_ATTRIBUTE

Fields inherited from class ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
TimestampAction()

Method Summary

Modifier and Type	Method	Description
protected Model	buildCurrentModel(SaxEventInterpretationContext interpretationContext, String name, Attributes attributes)	Builds and returns a Model instance for the current XML element being processed.
protected boolean	validPreconditions(SaxEventInterpretationContext interpretationContext, String name, Attributes attributes)	Validate preconditions of this action.

Methods inherited from class BaseModelAction

begin, body, end

Methods inherited from class Action

atLine, getColumnNumber, getLineColStr, getLineNumber, nearLine, toString

Methods inherited from class ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class Object

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

Field Details

DATE_PATTERN_ATTRIBUTE

public static final String DATE_PATTERN_ATTRIBUTE

See Also:

• Constant Field Values

TIME_REFERENCE_ATTRIBUTE

public static final String TIME_REFERENCE_ATTRIBUTE

See Also:

• Constant Field Values

Constructor Details

TimestampAction

public TimestampAction()

Method Details

validPreconditions

protected boolean validPreconditions(SaxEventInterpretationContext interpretationContext,
 String name,
 Attributes attributes)

Description copied from class: BaseModelAction

Validate preconditions of this action. By default, true is returned. Subclasses should override appropriately.

Overrides:

validPreconditions in class BaseModelAction

Parameters:

interpretationContext -

name -

attributes -

Returns:

buildCurrentModel

protected Model buildCurrentModel(SaxEventInterpretationContext interpretationContext,
 String name,
 Attributes attributes)

Description copied from class: BaseModelAction

Builds and returns a Model instance for the current XML element being processed.

This method is called during the begin phase of XML processing to create a Model object that represents the current element. The returned model will be configured with the element's tag name, line number, and will be pushed onto the model stack.

Specified by:

buildCurrentModel in class BaseModelAction

Parameters:

interpretationContext - the context for interpreting SAX events, providing access to the model stack and other interpretation state

name - the name of the XML element being processed

attributes - the attributes of the XML element

Returns:

a new Model instance representing the current XML element