InterpretationContext (Logback Core Module 1.3.0-alpha5 API)

java.lang.Object
- ch.qos.logback.core.spi.ContextAwareBase
- - ch.qos.logback.core.joran.spi.InterpretationContext

All Implemented Interfaces:

ContextAware, PropertyContainer
```
public class InterpretationContext
extends ContextAwareBase
implements PropertyContainer
```
An InterpretationContext contains the contextual state of a Joran parsing session. Action objects depend on this context to exchange and store information.

Author:

Ceki Gülcü

Field Summary
- Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase
  context

Constructor Summary

Constructors
Constructor and Description

InterpretationContext(Context context, SaxEventInterpreter saxEventInterpreter)

Constructors
Constructor and Description
`InterpretationContext(Context context, SaxEventInterpreter saxEventInterpreter)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSubstitutionProperties(Properties props)`
`void`	`addSubstitutionProperty(String key, String value)` Add a property to the properties of this execution context.
`BeanDescriptionCache`	`getBeanDescriptionCache()`
`Stack<Model>`	`getCopyOfModelStack()`
`Map<String,String>`	`getCopyOfPropertyMap()`
`DefaultNestedComponentRegistry`	`getDefaultNestedComponentRegistry()`
`Stack<ImplicitActionDataBase>`	`getImplcitActionDataStack()` actionDataStack contains ActionData instances We use a stack of ActionData objects in order to support nested elements which are handled by the same NestedComplexPropertyIA instance.
`String`	`getLineNumber()`
`Locator`	`getLocator()`
`Object`	`getObject(int i)`
`Map<String,Object>`	`getObjectMap()`
`Stack<Object>`	`getObjectStack()`
`String`	`getProperty(String key)` If a key is found in propertiesMap then return it.
`SaxEventInterpreter`	`getSaxEventInterpreter()`
`boolean`	`isEmpty()` Deprecated. Use `isObjectStackEmpty()` method instead
`boolean`	`isModelStackEmpty()`
`boolean`	`isObjectStackEmpty()`
`Model`	`peekModel()`
`Object`	`peekObject()`
`Model`	`popModel()`
`Object`	`popObject()`
`void`	`pushModel(Model m)`
`void`	`pushObject(Object o)`
`String`	`subst(String value)`

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, toString, wait, wait, wait

Constructor Detail

InterpretationContext

public InterpretationContext(Context context,
                             SaxEventInterpreter saxEventInterpreter)

Method Detail
- getBeanDescriptionCache
```
public BeanDescriptionCache getBeanDescriptionCache()
```
- getDefaultNestedComponentRegistry
```
public DefaultNestedComponentRegistry getDefaultNestedComponentRegistry()
```
- getCopyOfPropertyMap
```
public Map<String,String> getCopyOfPropertyMap()
```
  Specified by:
  
  getCopyOfPropertyMap in interface PropertyContainer
- getLineNumber
```
public String getLineNumber()
```
- getLocator
```
public Locator getLocator()
```
- getSaxEventInterpreter
```
public SaxEventInterpreter getSaxEventInterpreter()
```
- getObjectStack
```
public Stack<Object> getObjectStack()
```
- isEmpty
```
public boolean isEmpty()
```
  Deprecated. Use isObjectStackEmpty() method instead
  
  Returns:
- isObjectStackEmpty
```
public boolean isObjectStackEmpty()
```
  Returns:
  
  whether the objectStack is empty or not
- peekObject
```
public Object peekObject()
```
- pushObject
```
public void pushObject(Object o)
```
- popObject
```
public Object popObject()
```
- getImplcitActionDataStack
```
public Stack<ImplicitActionDataBase> getImplcitActionDataStack()
```
  actionDataStack contains ActionData instances We use a stack of ActionData objects in order to support nested elements which are handled by the same NestedComplexPropertyIA instance. We push a ActionData instance in the isApplicable method (if the action is applicable) and pop it in the end() method. The XML well-formedness property will guarantee that a push will eventually be followed by a corresponding pop.
- peekModel
```
public Model peekModel()
```
- pushModel
```
public void pushModel(Model m)
```
- isModelStackEmpty
```
public boolean isModelStackEmpty()
```
- popModel
```
public Model popModel()
```
- getCopyOfModelStack
```
public Stack<Model> getCopyOfModelStack()
```
- getObject
```
public Object getObject(int i)
```
- getObjectMap
```
public Map<String,Object> getObjectMap()
```
- addSubstitutionProperty
```
public void addSubstitutionProperty(String key,
                                    String value)
```
  Add a property to the properties of this execution context. If the property exists already, it is overwritten.
- addSubstitutionProperties
```
public void addSubstitutionProperties(Properties props)
```
- getProperty
```
public String getProperty(String key)
```
  If a key is found in propertiesMap then return it. Otherwise, delegate to the context.
  
  Specified by:
  
  getProperty in interface PropertyContainer
- subst
```
public String subst(String value)
```

Class InterpretationContext

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

InterpretationContext

Method Detail

getBeanDescriptionCache

getDefaultNestedComponentRegistry

getCopyOfPropertyMap

getLineNumber

getLocator

getSaxEventInterpreter

getObjectStack

isEmpty

isObjectStackEmpty

peekObject

pushObject

popObject

getImplcitActionDataStack

peekModel

pushModel

isModelStackEmpty

popModel

getCopyOfModelStack

getObject

getObjectMap

addSubstitutionProperty

addSubstitutionProperties

getProperty

subst