org.perfcake.util.properties

Enum SystemPropertyGetter

java.lang.Object

java.lang.Enum<SystemPropertyGetter>

org.perfcake.util.properties.SystemPropertyGetter

All Implemented Interfaces:

Serializable, Comparable<SystemPropertyGetter>, PropertyGetter

public enum SystemPropertyGetter
extends Enum<SystemPropertyGetter>
implements PropertyGetter

Provides system properties.

Author:

Pavel Macík, Martin Večeřa

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
String	getProperty(String propName) Gets a property with a given name or a null value, if the property is not found.
String	getProperty(String name, String defaultValue) Returns a property value.
static SystemPropertyGetter	valueOf(String name) Returns the enum constant of this type with the specified name.
static SystemPropertyGetter[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final SystemPropertyGetter INSTANCE

Method Detail

values

public static SystemPropertyGetter[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SystemPropertyGetter c : SystemPropertyGetter.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SystemPropertyGetter valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getProperty

public String getProperty(String name,
                          String defaultValue)

Returns a property value. First it checks whether a namespace of 'env.' or 'props.' was given as a property name prefix. If so, the property must be taken from these, otherwise the default value is returned. Second (as no namespace is specified) it looks at system properties using System.getProperty(String), if the system property does not exist it looks at environment variables using System.getenv(String). If the variable does not exist the method returns defautValue.

Specified by:

getProperty in interface PropertyGetter

Parameters:

name - Property name

defaultValue - Default property value

Returns:

Property value or defaultValue.

getProperty

public String getProperty(String propName)

Description copied from interface: PropertyGetter

Gets a property with a given name or a null value, if the property is not found.

Specified by:

getProperty in interface PropertyGetter

Parameters:

propName - Property name.

Returns:

Property value or a null, if property is not found.