Module ch.qos.logback.core

Package ch.qos.logback.core.joran.action

Class BaseModelAction

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

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

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

All Implemented Interfaces:

ContextAware

Direct Known Subclasses:

AppenderAction, AppenderRefAction, ByPropertiesConditionAction, ConfigurationAction, ContextNameAction, ConversionRuleAction, DefinePropertyAction, ElseAction, EventEvaluatorAction, IfAction, ImportAction, InsertFromJNDIAction, LevelAction, LoggerAction, LoggerContextListenerAction, ParamAction, PropertyAction, ResourceAction, RootLoggerAction, SequenceNumberGeneratorAction, SerializeModelAction, ShutdownHookAction, SiftAction, StatusListenerAction, ThenAction, TimestampAction

public abstract class BaseModelAction
extends Action

Field Summary

Fields inherited from class ch.qos.logback.core.joran.action.Action

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

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor	Description
BaseModelAction()

Method Summary

Modifier and Type	Method	Description
void	begin(SaxEventInterpretationContext saxEventInterpretationContext, String name, Attributes attributes)	Called when the parser encounters an element matching a Pattern.
void	body(SaxEventInterpretationContext ec, String body)	Called to pass the body (as text) contained within an element.
protected abstract Model	buildCurrentModel(SaxEventInterpretationContext interpretationContext, String name, Attributes attributes)	Builds and returns a Model instance for the current XML element being processed.
void	end(SaxEventInterpretationContext saxEventInterpretationContext, String name)
protected boolean	validPreconditions(SaxEventInterpretationContext intercon, String name, Attributes attributes)	Validate preconditions of this action.

Methods inherited from class ch.qos.logback.core.joran.action.Action

atLine, getColumnNumber, getLineColStr, getLineNumber, nearLine, toString

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseModelAction

public BaseModelAction()

Method Detail

begin

public void begin(SaxEventInterpretationContext saxEventInterpretationContext,
                  String name,
                  Attributes attributes)
           throws ActionException

Description copied from class: Action

Called when the parser encounters an element matching a Pattern.

Specified by:

begin in class Action

Throws:

ActionException

buildCurrentModel

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

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.

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

validPreconditions

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

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

Parameters:

intercon -

name -

attributes -

Returns:

body

public void body(SaxEventInterpretationContext ec,
                 String body)
          throws ActionException

Description copied from class: Action

Called to pass the body (as text) contained within an element.

Overrides:

body in class Action

Throws:

ActionException

end

public void end(SaxEventInterpretationContext saxEventInterpretationContext,
                String name)
         throws ActionException

Specified by:

end in class Action

Throws:

ActionException