org.refcodes.data

Enum EnvironmentProperty

java.lang.Object

java.lang.Enum<EnvironmentProperty>

org.refcodes.data.EnvironmentProperty

All Implemented Interfaces:

Serializable, Comparable<EnvironmentProperty>, org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.ValueAccessor<String>

public enum EnvironmentProperty
extends Enum<EnvironmentProperty>
implements org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.ValueAccessor<String>

EnvironmentProperty for retrieving some common environment variables with ease.

Nested Class Summary

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

org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B extends org.refcodes.mixin.KeyAccessor.KeyBuilder<K,B>>, org.refcodes.mixin.KeyAccessor.KeyMutator<K>, org.refcodes.mixin.KeyAccessor.KeyProperty<K>

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

org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V,B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V>, org.refcodes.mixin.ValueAccessor.ValueProperty<V>

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPUTERNAME The environment variable (on windows) holding the computer's name.
CONSOLE_HEIGHT The console height environment variable.
CONSOLE_WIDTH The console width environment variable on *ix like shells.
USER_HOME Environment variable holding the user's home folder path.

Method Summary

Modifier and Type	Method and Description
String	getKey()
String	getValue()
static EnvironmentProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static EnvironmentProperty[]	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

CONSOLE_HEIGHT

public static final EnvironmentProperty CONSOLE_HEIGHT

The console height environment variable.

CONSOLE_WIDTH

public static final EnvironmentProperty CONSOLE_WIDTH

The console width environment variable on *ix like shells.

COMPUTERNAME

public static final EnvironmentProperty COMPUTERNAME

The environment variable (on windows) holding the computer's name.

USER_HOME

public static final EnvironmentProperty USER_HOME

Environment variable holding the user's home folder path.

Method Detail

values

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

Returns:

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

valueOf

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

getKey

public String getKey()

Specified by:

getKey in interface org.refcodes.mixin.KeyAccessor<String>

getValue

public String getValue()

Specified by:

getValue in interface org.refcodes.mixin.ValueAccessor<String>