org.refcodes.data

Enum SystemProperty

java.lang.Object

java.lang.Enum<SystemProperty>

org.refcodes.data.SystemProperty

All Implemented Interfaces:

Serializable, Comparable<SystemProperty>, org.refcodes.mixin.NameAccessor

public enum SystemProperty
extends Enum<SystemProperty>
implements org.refcodes.mixin.NameAccessor

SystemProperty define values to be used at runtime. Them are passed to a JVM by prefixing a "-D" to the actual "property=value" pair.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONFIG_DIR Pass as JVM argument via "-Dconfig.dir=path_to_your_config_dir" (where path_to_your_config_dir stands for the path to the directory where you placed configuration files such as the "runtimelogger-config.xml" file).
CONSOLE_HEIGHT Pass as JVM argument via "-Dconsole.height=n" (where n stands for the number of lines).
CONSOLE_WIDTH Pass as JVM argument via "-Dconsole.width=n" (where n stands for the number of chars per row).
FILE_SEPARATOR The OS specific file separator is retrieved by this system property.
LINE_SEPARATOR
OPERATING_SYSTEM_NAME
PROCESS_ID At least set on Ubuntu Linux:
TEMP_DIR The OS specific temp folder path.
USER_HOME System variable holding the user's home folder path.

Method Summary

Modifier and Type	Method and Description
String	getName()
String	toValue() Retrieves the system property value identified by the system propertie's name.
static SystemProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static SystemProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONFIG_DIR

public static final SystemProperty CONFIG_DIR

Pass as JVM argument via "-Dconfig.dir=path_to_your_config_dir" (where path_to_your_config_dir stands for the path to the directory where you placed configuration files such as the "runtimelogger-config.xml" file).

FILE_SEPARATOR

public static final SystemProperty FILE_SEPARATOR

The OS specific file separator is retrieved by this system property. ATTENTION: System properties are to be retrieved via System.getProperty(String).

TEMP_DIR

public static final SystemProperty TEMP_DIR

The OS specific temp folder path.

PROCESS_ID

public static final SystemProperty PROCESS_ID

At least set on Ubuntu Linux:

LINE_SEPARATOR

public static final SystemProperty LINE_SEPARATOR

OPERATING_SYSTEM_NAME

public static final SystemProperty OPERATING_SYSTEM_NAME

CONSOLE_HEIGHT

public static final SystemProperty CONSOLE_HEIGHT

Pass as JVM argument via "-Dconsole.height=n" (where n stands for the number of lines).

CONSOLE_WIDTH

public static final SystemProperty CONSOLE_WIDTH

Pass as JVM argument via "-Dconsole.width=n" (where n stands for the number of chars per row).

USER_HOME

public static final SystemProperty USER_HOME

System variable holding the user's home folder path.

Method Detail

values

public static SystemProperty[] 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 (SystemProperty c : SystemProperty.values())
    System.out.println(c);

Returns:

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

valueOf

public static SystemProperty 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

getName

public String getName()

Specified by:

getName in interface org.refcodes.mixin.NameAccessor

toValue

public String toValue()

Retrieves the system property value identified by the system propertie's name.

Returns: