Modifier and Type	Class and Description
public static class	PropertySource.Comparator Comparator for ordering PropertySource instances by priority.
public static class	PropertySource.Util Utility methods useful for PropertySource implementations.

Method Summary

Modifier and Type	Method and Description
public default boolean	Returns: The value or null; containsProperty(String The key to search for. key) For PropertySources that cannot iterate over all the potential properties this provides a direct lookup.
public default void	forEach(BiConsumer<String, String> action to perform on each key/value pair action) Iterates over all properties and performs an action for each key/value pair.
public default CharSequence	Returns: a normalized property name using the given tokens getNormalForm(Iterable<? extends CharSequence> list of property name tokens tokens) Converts a list of property name tokens into a normal form.
public int	Returns: priority value getPriority() Returns the order in which this PropertySource has priority.
public default String	Returns: The value or null; getProperty(String The key to search for. key) For PropertySources that cannot iterate over all the potential properties this provides a direct lookup.
public default Collection<String>	Returns: list of property names getPropertyNames() Returns the list of all property names.

Method Detail

containsProperty	back to summary
public default boolean containsProperty(String key) For PropertySources that cannot iterate over all the potential properties this provides a direct lookup. Parameters key:String The key to search for. Returns:boolean The value or null; Since 2.13.0

containsProperty

back to summary

public default boolean containsProperty(String key)

For PropertySources that cannot iterate over all the potential properties this provides a direct lookup.

Parameters

key:String: The key to search for.

Returns:boolean

The value or null;

Since

2.13.0

forEach	back to summary
public default void forEach(BiConsumer<String, String> action) Iterates over all properties and performs an action for each key/value pair. Parameters action:BiConsumer<String, String> action to perform on each key/value pair

forEach

back to summary

public default void forEach(BiConsumer<String, String> action)

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

Parameters

action:BiConsumer<String, String>: action to perform on each key/value pair

getNormalForm	back to summary
public default CharSequence getNormalForm(Iterable<? extends CharSequence> tokens) 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". Parameters tokens:Iterable<? extends CharSequence> list of property name tokens Returns:CharSequence a normalized property name using the given tokens

getNormalForm

back to summary

public default CharSequence getNormalForm(Iterable<? extends CharSequence> tokens)

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".

Parameters

tokens:Iterable<? extends CharSequence>: list of property name tokens

Returns:CharSequence

a normalized property name using the given tokens

getPriority	back to summary
public int getPriority() 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. Returns:int priority value

getPriority

back to summary

public int getPriority()

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.

Returns:int: priority value

getProperty	back to summary
public default String getProperty(String key) For PropertySources that cannot iterate over all the potential properties this provides a direct lookup. Parameters key:String The key to search for. Returns:String The value or null; Since 2.13.0

getProperty

back to summary

public default String getProperty(String key)

For PropertySources that cannot iterate over all the potential properties this provides a direct lookup.

Parameters

key:String: The key to search for.

Returns:String

The value or null;

Since

2.13.0

getPropertyNames	back to summary
public default Collection<String> getPropertyNames() Returns the list of all property names. Returns:Collection<String> list of property names

getPropertyNames

back to summary

public default Collection<String> getPropertyNames()

Returns the list of all property names.

Returns:Collection<String>: list of property names

org.apache.logging.log4j.util back to summary

public Class PropertySource.Comparator

Class Inheritance

extends Object
implements Comparator<PropertySource>, Serializable

java.lang.Object
org.apache.logging.log4j.util.PropertySource.Comparator

All Implemented Interfaces

java.io.Serializable, java.util.Comparator

Comparator for ordering PropertySource instances by priority.

Since: 2.10.0

Field Summary

Modifier and Type	Field and Description
private static final long	serialVersionUID

Constructor Summary

Access	Constructor and Description
public	Comparator()

Method Summary

Modifier and Type	Method and Description
public int	compare(final PropertySource the first object to be compared. o1, final PropertySource the second object to be compared. o2) Implements java.util.Comparator.compare. Compares its two arguments for order.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

serialVersionUID	back to summary
private static final long serialVersionUID

Constructor Detail

Comparator	back to summary
public Comparator()

Method Detail

compare back to summary

compare	back to summary
public int compare(final PropertySource o1, final PropertySource o2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters o1:PropertySource the first object to be compared. o2:PropertySource the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. Annotations @Override

public int compare(final PropertySource o1, final PropertySource o2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

o1:PropertySource: the first object to be compared.
o2:PropertySource: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

Annotations

@Override

org.apache.logging.log4j.util back to summary

public final Class PropertySource.Util

Class Inheritance

extends Object

java.lang.Object
org.apache.logging.log4j.util.PropertySource.Util

Utility methods useful for PropertySource implementations.

Since: 2.10.0

Field Summary

Modifier and Type	Field and Description
private static final Map<CharSequence, List<CharSequence>>	CACHE
private static final Pattern	PREFIX_PATTERN
private static final Pattern	PROPERTY_TOKENIZER

Constructor Summary

Access	Constructor and Description
private	Util()

Method Summary

Modifier and Type	Method and Description
public static CharSequence	Returns: tokensAsCamelCase joinAsCamelCase(final Iterable<? extends CharSequence> tokens to convert tokens) Joins a list of strings using camelCaseConventions.
public static List<CharSequence>	Returns: the property broken into lower case tokens tokenize(final CharSequence property name value) Converts a property name string into a list of tokens.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

CACHE	back to summary
private static final Map<CharSequence, List<CharSequence>> CACHE

PREFIX_PATTERN	back to summary
private static final Pattern PREFIX_PATTERN

PROPERTY_TOKENIZER	back to summary
private static final Pattern PROPERTY_TOKENIZER

Constructor Detail

Util	back to summary
private Util()

Method Detail

joinAsCamelCase	back to summary
public static CharSequence joinAsCamelCase(final Iterable<? extends CharSequence> tokens) Joins a list of strings using camelCaseConventions. Parameters tokens:Iterable<? extends CharSequence> tokens to convert Returns:CharSequence tokensAsCamelCase

joinAsCamelCase

back to summary

public static CharSequence joinAsCamelCase(final Iterable<? extends CharSequence> tokens)

Joins a list of strings using camelCaseConventions.

Parameters

tokens:Iterable<? extends CharSequence>: tokens to convert

Returns:CharSequence

tokensAsCamelCase

tokenize back to summary

tokenize	back to summary
public static List<CharSequence> tokenize(final CharSequence value) Converts a property name string into a list of tokens. This will strip a prefix of `log4j`, `log4j2`, `Log4j`, or `org.apache.logging.log4j`, along with separators of dash `-`, dot `.`, underscore `_`, and slash `/`. Tokens can also be separated by camel case conventions without needing a separator character in between. Parameters value:CharSequence property name Returns:List<CharSequence> the property broken into lower case tokens Annotations @SuppressWarnings:CollectionUndefinedEquality

public static List<CharSequence> tokenize(final CharSequence value)

Converts a property name string into a list of tokens. This will strip a prefix of log4j, log4j2, Log4j, or org.apache.logging.log4j, along with separators of dash -, dot ., underscore _, and slash /. Tokens can also be separated by camel case conventions without needing a separator character in between.

Parameters

value:CharSequence: property name

Returns:List<CharSequence>

the property broken into lower case tokens

Annotations

@SuppressWarnings:CollectionUndefinedEquality

public Interface PropertySource

Nested and Inner Type Summary

Method Summary

Method Detail

public Class PropertySource.Comparator

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class PropertySource.Util

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail