public final class PropertiesUtil extends Object
Helps access properties. This utility provides a method to override system properties by specifying properties in a properties file.
Constructor and Description |
---|
PropertiesUtil(Properties props)
Constructs a PropertiesUtil using a given Properties object as its source of defined properties.
|
PropertiesUtil(String propertiesFileName)
Constructs a PropertiesUtil for a given properties file name on the classpath.
|
Modifier and Type | Method and Description |
---|---|
static Properties |
extractSubset(Properties properties,
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(String name)
Gets the named property as a boolean value.
|
boolean |
getBooleanProperty(String name,
boolean defaultValue)
Gets the named property as a boolean value.
|
Charset |
getCharsetProperty(String name)
Gets the named property as a Charset value.
|
Charset |
getCharsetProperty(String name,
Charset defaultValue)
Gets the named property as a Charset value.
|
double |
getDoubleProperty(String name,
double defaultValue)
Gets the named property as a double.
|
int |
getIntegerProperty(String name,
int defaultValue)
Gets the named property as an integer.
|
long |
getLongProperty(String name,
long defaultValue)
Gets the named property as a long.
|
static PropertiesUtil |
getProperties()
Returns the PropertiesUtil used by Log4j.
|
String |
getStringProperty(String name)
Gets the named property as a String.
|
String |
getStringProperty(String name,
String defaultValue)
Gets the named property as a String.
|
static 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.
|
static Map<String,Properties> |
partitionOnCommonPrefixes(Properties properties)
Partitions a properties map based on common key prefixes up to the first period.
|
public PropertiesUtil(Properties props)
props
- the Properties to use by defaultpublic PropertiesUtil(String propertiesFileName)
propertiesFileName
- the location of properties file to loadpublic static PropertiesUtil getProperties()
public boolean getBooleanProperty(String name)
"true"
(case-insensitive),
then it is returned as the boolean value true
. Any other non-null
text in the property is
considered false
.name
- the name of the property to look upfalse
if undefined.public boolean getBooleanProperty(String name, boolean defaultValue)
name
- the name of the property to look updefaultValue
- the default value to use if the property is undefineddefaultValue
if undefined.public Charset getCharsetProperty(String name)
name
- the name of the property to look upCharset.defaultCharset()
if undefined.public Charset getCharsetProperty(String name, Charset defaultValue)
name
- the name of the property to look updefaultValue
- the default value to use if the property is undefineddefaultValue
if undefined.public double getDoubleProperty(String name, double defaultValue)
name
- the name of the property to look updefaultValue
- the default value to use if the property is undefineddefaultValue
if it was undefined or could not be parsed.public int getIntegerProperty(String name, int defaultValue)
name
- the name of the property to look updefaultValue
- the default value to use if the property is undefineddefaultValue
if it was undefined or could not be
parsed.public long getLongProperty(String name, long defaultValue)
name
- the name of the property to look updefaultValue
- the default value to use if the property is undefineddefaultValue
if it was undefined or could not be parsed.public String getStringProperty(String name)
name
- the name of the property to look upnull
if undefined.public String getStringProperty(String name, String defaultValue)
name
- the name of the property to look updefaultValue
- the default value to use if the property is undefineddefaultValue
if undefined.public static Properties getSystemProperties()
public static Properties extractSubset(Properties properties, String prefix)
properties
- The Properties to evaluate.prefix
- The prefix to extract.public static Map<String,Properties> partitionOnCommonPrefixes(Properties properties)
properties
- properties to partitionpublic boolean isOsWindows()
Copyright © 1999-2017. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.