org.apache.logging.log4j.util

Class PropertiesPropertySource

java.lang.Object

org.apache.logging.log4j.util.PropertiesPropertySource

All Implemented Interfaces:

PropertySource

Direct Known Subclasses:

PropertyFilePropertySource

public class PropertiesPropertySource
extends java.lang.Object
implements PropertySource

PropertySource backed by a Properties instance. Normalized property names follow a scheme like this: Log4jContextSelector would normalize to log4j2.contextSelector.

Since:

2.10.0

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.logging.log4j.util.PropertySource

PropertySource.Comparator, PropertySource.Util

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	PREFIX
private java.util.Properties	properties

Constructor Summary

Constructors

Constructor and Description
PropertiesPropertySource(java.util.Properties properties)

Method Summary

Modifier and Type	Method and Description
void	forEach(BiConsumer<java.lang.String,java.lang.String> action) Iterates over all properties and performs an action for each key/value pair.
java.lang.CharSequence	getNormalForm(java.lang.Iterable<? extends java.lang.CharSequence> tokens) Converts a list of property name tokens into a normal form.
int	getPriority() Returns the order in which this PropertySource has priority.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.util.PropertySource

containsProperty, getProperty

Field Detail

PREFIX

private static final java.lang.String PREFIX

See Also:

Constant Field Values

properties

private final java.util.Properties properties

Constructor Detail

PropertiesPropertySource

public PropertiesPropertySource(java.util.Properties properties)

Method Detail

getPriority

public int getPriority()

Description copied from interface: PropertySource

Returns the order in which this PropertySource has priority. A higher value means that the source will be applied later so as to take precedence over other property sources.

Specified by:

getPriority in interface PropertySource

Returns:

priority value

forEach

public void forEach(BiConsumer<java.lang.String,java.lang.String> action)

Description copied from interface: PropertySource

Iterates over all properties and performs an action for each key/value pair.

Specified by:

forEach in interface PropertySource

Parameters:

action - action to perform on each key/value pair

getNormalForm

public java.lang.CharSequence getNormalForm(java.lang.Iterable<? extends java.lang.CharSequence> tokens)

Description copied from interface: PropertySource

Converts a list of property name tokens into a normal form. For example, a list of tokens such as "foo", "bar", "baz", might be normalized into the property name "log4j2.fooBarBaz".

Specified by:

getNormalForm in interface PropertySource

Parameters:

tokens - list of property name tokens

Returns:

a normalized property name using the given tokens