org.apache.logging.log4j.util

Class PropertiesUtil

java.lang.Object

org.apache.logging.log4j.util.PropertiesUtil

public final class PropertiesUtil
extends java.lang.Object

Consider this class private.

Helps access properties. This utility provides a method to override system properties by specifying properties in a properties file.

Field Summary

Fields

Modifier and Type	Field and Description
private static PropertiesUtil	LOG4J_PROPERTIES
private java.util.Properties	props

Constructor Summary

Constructors

Constructor and Description
PropertiesUtil(java.util.Properties props) Constructs a PropertiesUtil using a given Properties object as its source of defined properties.
PropertiesUtil(java.lang.String propertiesFileName) Constructs a PropertiesUtil for a given properties file name on the classpath.

Method Summary

Modifier and Type	Method and Description
static java.util.Properties	extractSubset(java.util.Properties properties, java.lang.String prefix) Extracts properties that start with or are equals to the specific prefix and returns them in a new Properties object with the prefix removed.
boolean	getBooleanProperty(java.lang.String name) Gets the named property as a boolean value.
boolean	getBooleanProperty(java.lang.String name, boolean defaultValue) Gets the named property as a boolean value.
java.nio.charset.Charset	getCharsetProperty(java.lang.String name) Gets the named property as a Charset value.
java.nio.charset.Charset	getCharsetProperty(java.lang.String name, java.nio.charset.Charset defaultValue) Gets the named property as a Charset value.
double	getDoubleProperty(java.lang.String name, double defaultValue) Gets the named property as a double.
int	getIntegerProperty(java.lang.String name, int defaultValue) Gets the named property as an integer.
long	getLongProperty(java.lang.String name, long defaultValue) Gets the named property as a long.
static PropertiesUtil	getProperties() Returns the PropertiesUtil used by Log4j.
java.lang.String	getStringProperty(java.lang.String name) Gets the named property as a String.
java.lang.String	getStringProperty(java.lang.String name, java.lang.String defaultValue) Gets the named property as a String.
static java.util.Properties	getSystemProperties() Return the system properties or an empty Properties object if an error occurs.
boolean	isOsWindows() Returns true if system properties tell us we are running on Windows.
(package private) static java.util.Properties	loadClose(java.io.InputStream in, java.lang.Object source) Loads and closes the given property input stream.
static java.util.Map<java.lang.String,java.util.Properties>	partitionOnCommonPrefixes(java.util.Properties properties) Partitions a properties map based on common key prefixes up to the first period.

Methods inherited from class java.lang.Object

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

Field Detail

LOG4J_PROPERTIES

private static final PropertiesUtil LOG4J_PROPERTIES

props

private final java.util.Properties props

Constructor Detail

PropertiesUtil

public PropertiesUtil(java.util.Properties props)

Constructs a PropertiesUtil using a given Properties object as its source of defined properties.

Parameters:

props - the Properties to use by default

PropertiesUtil

public PropertiesUtil(java.lang.String propertiesFileName)

Constructs a PropertiesUtil for a given properties file name on the classpath. The properties specified in this file are used by default. If a property is not defined in this file, then the equivalent system property is used.

Parameters:

propertiesFileName - the location of properties file to load

Method Detail

loadClose

static java.util.Properties loadClose(java.io.InputStream in,
                                      java.lang.Object source)

Loads and closes the given property input stream. If an error occurs, log to the status logger.

Parameters:

in - a property input stream.

source - a source object describing the source, like a resource string or a URL.

Returns:

a new Properties object

getProperties

public static PropertiesUtil getProperties()

Returns the PropertiesUtil used by Log4j.

Returns:

the main Log4j PropertiesUtil instance.

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name)

Gets the named property as a boolean value. If the property matches the string "true" (case-insensitive), then it is returned as the boolean value true. Any other non-null text in the property is considered false.

Parameters:

name - the name of the property to look up

Returns:

the boolean value of the property or false if undefined.

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name,
                                  boolean defaultValue)

Gets the named property as a boolean value.

Parameters:

name - the name of the property to look up

defaultValue - the default value to use if the property is undefined

Returns:

the boolean value of the property or defaultValue if undefined.

getCharsetProperty

public java.nio.charset.Charset getCharsetProperty(java.lang.String name)

Gets the named property as a Charset value.

Parameters:

name - the name of the property to look up

Returns:

the Charset value of the property or Charset.defaultCharset() if undefined.

getCharsetProperty

public java.nio.charset.Charset getCharsetProperty(java.lang.String name,
                                                   java.nio.charset.Charset defaultValue)

Gets the named property as a Charset value.

Parameters:

name - the name of the property to look up

defaultValue - the default value to use if the property is undefined

Returns:

the Charset value of the property or defaultValue if undefined.

getDoubleProperty

public double getDoubleProperty(java.lang.String name,
                                double defaultValue)

Gets the named property as a double.

Parameters:

name - the name of the property to look up

defaultValue - the default value to use if the property is undefined

Returns:

the parsed double value of the property or defaultValue if it was undefined or could not be parsed.

getIntegerProperty

public int getIntegerProperty(java.lang.String name,
                              int defaultValue)

Gets the named property as an integer.

Parameters:

name - the name of the property to look up

defaultValue - the default value to use if the property is undefined

Returns:

the parsed integer value of the property or defaultValue if it was undefined or could not be parsed.

getLongProperty

public long getLongProperty(java.lang.String name,
                            long defaultValue)

Gets the named property as a long.

Parameters:

name - the name of the property to look up

defaultValue - the default value to use if the property is undefined

Returns:

the parsed long value of the property or defaultValue if it was undefined or could not be parsed.

getStringProperty

public java.lang.String getStringProperty(java.lang.String name)

Gets the named property as a String.

Parameters:

name - the name of the property to look up

Returns:

the String value of the property or null if undefined.

getStringProperty

public java.lang.String getStringProperty(java.lang.String name,
                                          java.lang.String defaultValue)

Gets the named property as a String.

Parameters:

name - the name of the property to look up

defaultValue - the default value to use if the property is undefined

Returns:

the String value of the property or defaultValue if undefined.

getSystemProperties

public static java.util.Properties getSystemProperties()

Return the system properties or an empty Properties object if an error occurs.

Returns:

The system properties.

extractSubset

public static java.util.Properties extractSubset(java.util.Properties properties,
                                                 java.lang.String prefix)

Extracts properties that start with or are equals to the specific prefix and returns them in a new Properties object with the prefix removed.

Parameters:

properties - The Properties to evaluate.

prefix - The prefix to extract.

Returns:

The subset of properties.

partitionOnCommonPrefixes

public static java.util.Map<java.lang.String,java.util.Properties> partitionOnCommonPrefixes(java.util.Properties properties)

Partitions a properties map based on common key prefixes up to the first period.

Parameters:

properties - properties to partition

Returns:

the partitioned properties where each key is the common prefix (minus the period) and the values are new property maps without the prefix and period in the key

Since:

2.6

isOsWindows

public boolean isOsWindows()

Returns true if system properties tell us we are running on Windows.

Returns:

true if system properties tell us we are running on Windows.