org.apache.logging.log4j.core.config

Class Property

java.lang.Object

org.apache.logging.log4j.core.config.Property

@Plugin(name="property",
        category="Core",
        printObject=true)
public final class Property
extends Object

Represents a key/value pair in the configuration.

Field Summary

Fields

Modifier and Type	Field and Description
static Property[]	EMPTY_ARRAY

Method Summary

Modifier and Type	Method and Description
static Property	createProperty(String name, String value) Creates a Property.
static Property	createProperty(String name, String rawValue, Configuration configuration) Creates a Property.
static Property	createProperty(String name, String rawValue, String value) Creates a Property.
String	evaluate(StrSubstitutor substitutor) Evaluate this property with the provided substitutor.
String	getName() Returns the property name.
String	getRawValue() Returns the original raw property value without substitution.
String	getValue() Returns the property value.
boolean	isValueNeedsLookup() Returns true if the value contains a substitutable property that requires a lookup to be resolved.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final Property[] EMPTY_ARRAY

Since:

2.11.2

Method Detail

getName

public String getName()

Returns the property name.

Returns:

the property name.

getRawValue

public String getRawValue()

Returns the original raw property value without substitution.

Returns:

the raw value of the property, or empty string if it is not set.

getValue

public String getValue()

Returns the property value.

Returns:

the value of the property.

isValueNeedsLookup

public boolean isValueNeedsLookup()

Returns true if the value contains a substitutable property that requires a lookup to be resolved.

Returns:

true if the value contains "${"}, {@code false} otherwise

evaluate

public String evaluate(StrSubstitutor substitutor)

Evaluate this property with the provided substitutor. If isValueNeedsLookup() is false, the value is returned, otherwise the raw value is evaluated with the given substitutor.

createProperty

public static Property createProperty(String name,
                                      String value)

Creates a Property.

Parameters:

name - The key.

value - The value.

Returns:

A Property.

createProperty

public static Property createProperty(String name,
                                      String rawValue,
                                      String value)

Creates a Property.

Parameters:

name - The key.

rawValue - The value without any substitution applied.

value - The value.

Returns:

A Property.

createProperty

@PluginFactory
public static Property createProperty(@PluginAttribute(value="name")
                                                     String name,
                                                     @PluginValue(value="value",substitute=false)
                                                     String rawValue,
                                                     @PluginConfiguration
                                                     Configuration configuration)

Creates a Property.

Parameters:

name - The key.

rawValue - The value without any substitution applied.

configuration - configuration used to resolve the property value from the rawValue

Returns:

A Property.

toString

public String toString()

Overrides:

toString in class Object