Class PropertyConditionBase

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.boolex.PropertyConditionBase

All Implemented Interfaces:

PropertyCondition, Condition, ContextAware, LifeCycle

Direct Known Subclasses:

ExpressionPropertyCondition, IsPropertyDefinedCondition, IsPropertyNullCondition, PropertyEqualityCondition

public abstract class PropertyConditionBase
extends ContextAwareBase
implements PropertyCondition

Abstract base class provides some scaffolding. It is intended to ease migration from legacy conditional processing in configuration files (e.g. <if>, <then>, <else>) using the Janino library. Nevertheless, it should also be useful in newly written code.

Properties are looked up in the following order:

1. In the local property container, usually the ModelInterpretationContext
2. in the logger context
3. system properties
4. environment variables

Since:

1.5.20

Author:

Ceki Gülcü

See Also:

• OptionHelper.propertyLookup(String, PropertyContainer, PropertyContainer)

Field Summary

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

context

Constructor Summary

Constructors

Constructor	Description
PropertyConditionBase()

Method Summary

Modifier and Type	Method	Description
PropertyContainer	getLocalPropertyContainer()	Returns the local property container used by this evaluator.
boolean	isDefined(String k)	Checks if the property with the given key is defined (not null).
boolean	isNull(String k)	Checks if the property with the given key is null.
boolean	isStarted()	Checks if this evaluator has been started.
String	p(String k)	Retrieves the property value for the given key, returning an empty string if null.
String	property(String k)	Retrieves the property value for the given key, returning an empty string if null.
boolean	propertyContains(String k, String inclusion)	Determine whether the resolved property value contains the given substring.
boolean	propertyEquals(String propertyKey, String value)	Compare the resolved property value with the provided expected value.
void	setLocalPropertyContainer(PropertyContainer aLocalPropertyContainer)	Sets the local property container for this evaluator.
void	start()	Starts this evaluator.
void	stop()	Stops this evaluator.

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.joran.conditional.Condition

evaluate

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

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

Constructor Details

PropertyConditionBase

public PropertyConditionBase()

Method Details

getLocalPropertyContainer

public PropertyContainer getLocalPropertyContainer()

Returns the local property container used by this evaluator.

Local properties correspond to the properties in the embedding configurator, i.e. usually the ModelInterpretationContext instance.

Specified by:

getLocalPropertyContainer in interface PropertyCondition

Returns:

the local property container

setLocalPropertyContainer

public void setLocalPropertyContainer(PropertyContainer aLocalPropertyContainer)

Sets the local property container for this evaluator.

Local properties correspond to the properties in the embedding configurator, i.e. usually the ModelInterpretationContext instance.

Specified by:

setLocalPropertyContainer in interface PropertyCondition

Parameters:

aLocalPropertyContainer - the local property container to set

isNull

public boolean isNull(String k)

Checks if the property with the given key is null.

The property is looked up via the OptionHelper.propertyLookup(String, PropertyContainer, PropertyContainer) method. See above for the lookup order.

Parameters:

k - the property key

Returns:

true if the property is null, false otherwise

isDefined

public boolean isDefined(String k)

Checks if the property with the given key is defined (not null).

The property is looked up via the OptionHelper.propertyLookup(String, PropertyContainer, PropertyContainer) method. See above for the lookup order.

Parameters:

k - the property key

Returns:

true if the property is defined, false otherwise

p

public String p(String k)

Retrieves the property value for the given key, returning an empty string if null. This is a shorthand for property(String).

Parameters:

k - the property key

Returns:

the property value or an empty string

property

public String property(String k)

Retrieves the property value for the given key, returning an empty string if null.

The property is looked up via the OptionHelper.propertyLookup(String, PropertyContainer, PropertyContainer) method. See above for the lookup order.

Parameters:

k - the property key

Returns:

the property value or an empty string

propertyEquals

public boolean propertyEquals(String propertyKey,
 String value)

Compare the resolved property value with the provided expected value.

The property is looked up via the OptionHelper.propertyLookup(String, PropertyContainer, PropertyContainer) method. See above for the lookup order.

Returns true if the resolved property value is equal to val according to String.equals(Object). If the resolved property value or val is null, then false is returned.

Parameters:

propertyKey - the property key to look up

value - expected string value to compare against; must be non-null

Returns:

true if the resolved property equals value, false otherwise or if either the resolved property or value is null.

Since:

1.5.24

propertyContains

public boolean propertyContains(String k,
 String inclusion)

Determine whether the resolved property value contains the given substring.

The property is looked up via the OptionHelper.propertyLookup(String, PropertyContainer, PropertyContainer) method. See above for the lookup order.

This method returns true if the resolved property value's String.contains(CharSequence) returns true for the supplied inclusion. False is returned if either the resolved property value or inclusion parameter is null.

Parameters:

k - the property key to look up

inclusion - substring to search for in the resolved property value; must be non-null

Returns:

true if the property value contains inclusion, false otherwise or if either the resolved property value or inclusion is null

Since:

1.5.24

isStarted

public boolean isStarted()

Checks if this evaluator has been started.

Specified by:

isStarted in interface LifeCycle

Returns:

true if started, false otherwise

start

public void start()

Starts this evaluator.

Specified by:

start in interface LifeCycle

stop

public void stop()

Stops this evaluator.

Specified by:

stop in interface LifeCycle