Module org.apache.logging.log4j
Package org.apache.logging.log4j.util
Class PropertiesPropertySource
- java.lang.Object
-
- org.apache.logging.log4j.util.ContextAwarePropertySource
-
- org.apache.logging.log4j.util.PropertiesPropertySource
-
- All Implemented Interfaces:
PropertySource
,ReloadablePropertySource
- Direct Known Subclasses:
PropertyFilePropertySource
public class PropertiesPropertySource extends ContextAwarePropertySource implements ReloadablePropertySource
PropertySource backed by aProperties
instance. Normalized property names follow a scheme like this:Log4jContextSelector
would normalize tolog4j2.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 inherited from class org.apache.logging.log4j.util.ContextAwarePropertySource
propertiesMap
-
Fields inherited from interface org.apache.logging.log4j.util.PropertySource
DEFAULT_PRIORITY, MAPPING_FILE, PREFIX, SYSTEM_CONTEXT
-
-
Constructor Summary
Constructors Constructor Description PropertiesPropertySource(Properties properties)
PropertiesPropertySource(Properties properties, int priority)
PropertiesPropertySource(Properties properties, String contextName, int priority)
PropertiesPropertySource(Properties properties, String contextName, int priority, boolean includeInvalid)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object o)
void
forEach(BiConsumer<String,String> action)
Iterates over all properties and performs an action for each key/value pair.CharSequence
getNormalForm(Iterable<? extends CharSequence> tokens)
Converts a list of property name tokens into a normal form.int
getPriority()
Returns the order in which this PropertySource has priority.int
hashCode()
void
reload()
-
Methods inherited from class org.apache.logging.log4j.util.ContextAwarePropertySource
containsProperty, containsProperty, getPropertiesMap, getProperty, getProperty, getPropertyNames, getPropertyNames, parseProperties, parseProperties, parseProperties
-
-
-
-
Constructor Detail
-
PropertiesPropertySource
public PropertiesPropertySource(Properties properties)
-
PropertiesPropertySource
public PropertiesPropertySource(Properties properties, int priority)
-
PropertiesPropertySource
public PropertiesPropertySource(Properties properties, String contextName, int priority)
-
PropertiesPropertySource
public PropertiesPropertySource(Properties properties, String contextName, int priority, boolean includeInvalid)
-
-
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 searched later and can be overridden by other property sources.- Specified by:
getPriority
in interfacePropertySource
- Returns:
- priority value
-
forEach
public void forEach(BiConsumer<String,String> action)
Description copied from interface:PropertySource
Iterates over all properties and performs an action for each key/value pair.- Specified by:
forEach
in interfacePropertySource
- Parameters:
action
- action to perform on each key/value pair
-
getNormalForm
public CharSequence getNormalForm(Iterable<? extends CharSequence> tokens)
Description copied from interface:PropertySource
Converts a list of property name tokens into a normal form. For example, by default a list of tokens such as "foo", "bar", "baz", will be normalized into the property name "log4j2.foo.bar.baz". Note that this is normally used in conjunction with Util.tokenize() which breaks a string into tokens and then this puts them back together.- Specified by:
getNormalForm
in interfacePropertySource
- Parameters:
tokens
- list of property name tokens- Returns:
- a normalized property name using the given tokens
-
reload
public void reload()
- Specified by:
reload
in interfaceReloadablePropertySource
-
-