Class IsPropertyDefinedCondition

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.boolex.PropertyConditionBase

ch.qos.logback.core.boolex.IsPropertyDefinedCondition

All Implemented Interfaces:

PropertyCondition, Condition, ContextAware, LifeCycle

public class IsPropertyDefinedCondition
extends PropertyConditionBase

Checks whether a named property is defined in the context (e.g. system properties, environment, or the configured property map used by the surrounding framework).

This condition expects a property name to be provided via setKey(String). When evaluate() is called it returns true if the named property is defined and false otherwise.

Field Summary

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

context

Constructor Summary

Constructors

Constructor	Description
IsPropertyDefinedCondition()

Method Summary

Modifier and Type	Method	Description
boolean	evaluate()	Evaluate whether the configured property is defined.
String	getKey()	Return the configured property name (key) that this evaluator will test for definition.
void	setKey(String key)	Set the property name (key) to be checked by this evaluator.
void	start()	Start the evaluator.

Methods inherited from class ch.qos.logback.core.boolex.PropertyConditionBase

getLocalPropertyContainer, isDefined, isNull, isStarted, p, property, propertyContains, propertyEquals, setLocalPropertyContainer, stop

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

Constructor Details

IsPropertyDefinedCondition

public IsPropertyDefinedCondition()

Method Details

start

public void start()

Start the evaluator. If the required key is not set an error is reported and startup is aborted.

Specified by:

start in interface LifeCycle

Overrides:

start in class PropertyConditionBase

getKey

public String getKey()

Return the configured property name (key) that this evaluator will test for definition.

Returns:

the property key, or null if not set

setKey

public void setKey(String key)

Set the property name (key) to be checked by this evaluator.

Parameters:

key - the property name to check; must not be null

evaluate

public boolean evaluate()

Evaluate whether the configured property is defined.

Returns:

true if the property named by key is defined, false otherwise