Module ch.qos.logback.core

Package ch.qos.logback.core.model.processor

Class ModelInterpretationContext

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.model.processor.ModelInterpretationContext

All Implemented Interfaces:

ContextAware, ContextAwarePropertyContainer, PropertyContainer

public class ModelInterpretationContext
extends ContextAwareBase
implements ContextAwarePropertyContainer

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	importMap
protected VariableSubstitutionsHelper	variableSubstitutionsHelper

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

context

Constructor Summary

Constructors

Constructor	Description
ModelInterpretationContext(Context context)
ModelInterpretationContext(Context context, Object configuratorHint)
ModelInterpretationContext(ModelInterpretationContext otherMic)

Method Summary

Modifier and Type	Method	Description
void	addDependencyDefinition(DependencyDefinition dd)
void	addImport(String stem, String fqcn)	Add an import to the importMao
void	addSubstitutionProperty(String key, String value)	Add a property to the properties of this execution context.
void	createAppenderBags()
BeanDescriptionCache	getBeanDescriptionCache()
Object	getConfiguratorHint()
Supplier<? extends GenericXMLConfigurator>	getConfiguratorSupplier()	Returns a supplier of GenericXMLConfigurator instance.
Map<String,String>	getCopyOfPropertyMap()
DefaultNestedComponentRegistry	getDefaultNestedComponentRegistry()
List<DependencyDefinition>	getDependencyDefinitions()
List<String>	getDependencyNamesForModel(Model model)
String	getImport(String stem)	Given a stem, get the fully qualified name of the class corresponding to the stem.
Map<String,String>	getImportMapCopy()
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.
Model	getTopModel()
Boolean	getTopScanBoolean()
URL	getTopURL()
boolean	hasDependers(String dependencyName)
boolean	isModelStackEmpty()
boolean	isNamedDependemcyStarted(String name)
boolean	isObjectStackEmpty()
void	markStartOfNamedDependee(String name)
Model	peekModel()
Object	peekObject()
Model	popModel()
Object	popObject()
void	pushModel(Model m)
void	pushObject(Object o)
void	setConfiguratorHint(Object configuratorHint)
void	setConfiguratorSupplier(Supplier<? extends GenericXMLConfigurator> configuratorSupplier)
void	setTopModel(Model topModel)
void	setTopScanBoolean(Boolean topScanBoolean)
void	setTopURL(URL topURL)
String	subst(String ref)	Performs variable substitution on the provided ref string.

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Methods inherited from interface ch.qos.logback.core.spi.PropertyContainer

addSubstitutionProperties

Field Detail

variableSubstitutionsHelper

protected VariableSubstitutionsHelper variableSubstitutionsHelper

importMap

protected Map<String,String> importMap

Constructor Detail

ModelInterpretationContext

public ModelInterpretationContext(Context context)

ModelInterpretationContext

public ModelInterpretationContext(Context context,
                                  Object configuratorHint)

ModelInterpretationContext

public ModelInterpretationContext(ModelInterpretationContext otherMic)

Method Detail

getObjectMap

public Map<String,Object> getObjectMap()

createAppenderBags

public void createAppenderBags()

getTopModel

public Model getTopModel()

setTopModel

public void setTopModel(Model topModel)

pushModel

public void pushModel(Model m)

peekModel

public Model peekModel()

isModelStackEmpty

public boolean isModelStackEmpty()

popModel

public Model popModel()

getObjectStack

public Stack<Object> getObjectStack()

isObjectStackEmpty

public boolean isObjectStackEmpty()

peekObject

public Object peekObject()

pushObject

public void pushObject(Object o)

popObject

public Object popObject()

getObject

public Object getObject(int i)

getConfiguratorHint

public Object getConfiguratorHint()

setConfiguratorHint

public void setConfiguratorHint(Object configuratorHint)

getBeanDescriptionCache

public BeanDescriptionCache getBeanDescriptionCache()

subst

public String subst(String ref)

Performs variable substitution on the provided ref string.

Value substitution will follow the order

1. properties defined in this ModelInterpretationContext
2. properties defined in the context of this ModelInterpretationContext
3. System properties
4. Environment variables

If value substitution occurs it will be output as a status message, unless marked confidential, that is, if ref contains the case-insensitive strings PASSWORD, SECRET or CONFIDENTIAL.

Specified by:

subst in interface ContextAwarePropertyContainer

Parameters:

ref - the string that may contain variables to be substituted; can be null

Returns:

the string with substitutions applied if applicable; may return null if ref is null

getDefaultNestedComponentRegistry

public DefaultNestedComponentRegistry getDefaultNestedComponentRegistry()

addDependencyDefinition

public void addDependencyDefinition(DependencyDefinition dd)

getDependencyDefinitions

public List<DependencyDefinition> getDependencyDefinitions()

getDependencyNamesForModel

public List<String> getDependencyNamesForModel(Model model)

hasDependers

public boolean hasDependers(String dependencyName)

markStartOfNamedDependee

public void markStartOfNamedDependee(String name)

isNamedDependemcyStarted

public boolean isNamedDependemcyStarted(String name)

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.

Specified by:

addSubstitutionProperty in interface PropertyContainer

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

getCopyOfPropertyMap

public Map<String,String> getCopyOfPropertyMap()

Specified by:

getCopyOfPropertyMap in interface PropertyContainer

addImport

public void addImport(String stem,
                      String fqcn)

Add an import to the importMao

Parameters:

stem - the class to import

fqcn - the fully qualified name of the class

Since:

1.3

getImportMapCopy

public Map<String,String> getImportMapCopy()

getImport

public String getImport(String stem)

Given a stem, get the fully qualified name of the class corresponding to the stem. For unknown stems, returns the stem as is. If stem is null, null is returned.

Parameters:

stem - may be null

Returns:

fully qualified name of the class corresponding to the stem. For unknown stems, returns the stem as is. If stem is null, null is returned.

Since:

1.3

getConfiguratorSupplier

public Supplier<? extends GenericXMLConfigurator> getConfiguratorSupplier()

Returns a supplier of GenericXMLConfigurator instance. The returned value may be null.

Specified by:

getConfiguratorSupplier in interface ContextAwarePropertyContainer

Returns:

a supplier of GenericXMLConfigurator instance, may be null

setConfiguratorSupplier

public void setConfiguratorSupplier(Supplier<? extends GenericXMLConfigurator> configuratorSupplier)

Parameters:

configuratorSupplier -

getTopURL

public URL getTopURL()

setTopURL

public void setTopURL(URL topURL)

getTopScanBoolean

public Boolean getTopScanBoolean()

setTopScanBoolean

public void setTopScanBoolean(Boolean topScanBoolean)