Module org.refcodes.runtime

Package org.refcodes.runtime

Enum Class EnvironmentVariable

java.lang.Object

java.lang.Enum<EnvironmentVariable>

org.refcodes.runtime.EnvironmentVariable

All Implemented Interfaces:

Serializable, Comparable<EnvironmentVariable>, Constable, org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.ValueAccessor<String>, org.refcodes.mixin.ValueAccessor.ValueMutator<String>, org.refcodes.mixin.ValueAccessor.ValueProperty<String>

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

EnvironmentVariable for retrieving some common environment variables with ease.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

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	Description
ANSICON	The virtual and the physical console width height and environment variable.
COMPUTERNAME	The environment variable (on windows) holding the computer's name.
CONSOLE_ANSI	Set to "true" or "false", forces ANSI to be used / not used by REFCODES.ORG artifacts, no matter what capabilities were detected for the hosting terminal.
CONSOLE_CONEMU_ANSI	ConEmu's environment variable regarding ANSI support.
CONSOLE_HEIGHT	Stands for the lines per column to be taken by REFCODES.ORG artifacts.
CONSOLE_LINE_BREAK	The console's line-break property.
CONSOLE_WIDTH	Stands for the chars per row to be taken by REFCODES.ORG artifacts.
HOST_SEED	Environment variable "HOST_SEED" for the Host-Seed for host-related IDs.
HOSTNAME	The environment variable (on windows) holding the computer's name.
HTTP_PROXY	HTTP-Proxy setting in URL notation ("http://my.company.org:3128")
HTTPS_PROXY	HTTPS-Proxy setting in URL notation ("http://my.company.org:3128")
LANG	LANG is the normal environment variable for specifying a locale.
LOGGER_LAYOUT	Stands for the chosen layout for the REFCODES.ORG logger artifacts.
LOGGER_STYLE	Stands for the chosen style for the REFCODES.ORG logger artifacts.
NO_PROXY	No-Proxy settings for the HTTP_PROXY (HTTPS_PROXY) settings in a comma separated list ("localhost,127.0.0.0/8,127.0.1.1,127.0.1.1*,...")
NUMBER_OF_PROCESSORS	Number of processors.
PROCESSOR_ARCHITECTURE	Processor architecture on some systems (e.g.
PROCESSOR_ARCHITEW6432	Processor architecture on some systems (e.g.
STRUCT_KEEP_MAPS	When set to "true" then Map instances in data-structures are preserved instead of converting them to arrays if possible by indirectly calling StructureUtility.toDataStructure(PathMap, String) when invoking PathMap.toDataStructure().
TERM	Environment variable holding the current session's terminal.
TERMINAL_COLUMNS	The console width environment variable on *ix like shells.
TERMINAL_ENCODING	Environment variable holding the current session's terminal encoding.
TERMINAL_LINES	The console height environment variable.
TMPDIR	TMPDIR is the canonical environment variable in Unix and POSIX that should be used to specify a temporary directory for scratch space.
USER_DIR	Environment variable holding the user's current working directory path.
USER_HOME	Environment variable holding the user's home folder path.
USER_NAME	Environment variable holding the user's current working directory path.

Method Summary

Modifier and Type	Method	Description
String	getKey()
String	getValue()	Retrieves the value, first the upper-case variant of the environment variable is tried out.
void	setValue(String aValue)	Sets the value, first the upper-case variant of the environment variable is tried out.
static EnvironmentVariable	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EnvironmentVariable[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.refcodes.mixin.ValueAccessor

getValueOr

Methods inherited from interface org.refcodes.mixin.ValueAccessor.ValueProperty

letValue

Enum Constant Details

ANSICON

public static final EnvironmentVariable ANSICON

The virtual and the physical console width height and environment variable. E.g. ANSICON=80x19999 (80x25)

COMPUTERNAME

public static final EnvironmentVariable COMPUTERNAME

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

CONSOLE_ANSI

public static final EnvironmentVariable CONSOLE_ANSI

Set to "true" or "false", forces ANSI to be used / not used by REFCODES.ORG artifacts, no matter what capabilities were detected for the hosting terminal.

CONSOLE_CONEMU_ANSI

public static final EnvironmentVariable CONSOLE_CONEMU_ANSI

ConEmu's environment variable regarding ANSI support.

CONSOLE_HEIGHT

public static final EnvironmentVariable CONSOLE_HEIGHT

Stands for the lines per column to be taken by REFCODES.ORG artifacts.

CONSOLE_LINE_BREAK

public static final EnvironmentVariable CONSOLE_LINE_BREAK

The console's line-break property. Used to override any default line breaks for the REFCODES-ORG artifacts.

CONSOLE_WIDTH

public static final EnvironmentVariable CONSOLE_WIDTH

Stands for the chars per row to be taken by REFCODES.ORG artifacts.

HOST_SEED

public static final EnvironmentVariable HOST_SEED

Environment variable "HOST_SEED" for the Host-Seed for host-related IDs.

HOSTNAME

public static final EnvironmentVariable HOSTNAME

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

HTTP_PROXY

public static final EnvironmentVariable HTTP_PROXY

HTTP-Proxy setting in URL notation ("http://my.company.org:3128")

HTTPS_PROXY

public static final EnvironmentVariable HTTPS_PROXY

HTTPS-Proxy setting in URL notation ("http://my.company.org:3128")

LANG

public static final EnvironmentVariable LANG

LANG is the normal environment variable for specifying a locale.

LOGGER_LAYOUT

public static final EnvironmentVariable LOGGER_LAYOUT

Stands for the chosen layout for the REFCODES.ORG logger artifacts.

LOGGER_STYLE

public static final EnvironmentVariable LOGGER_STYLE

Stands for the chosen style for the REFCODES.ORG logger artifacts.

NO_PROXY

public static final EnvironmentVariable NO_PROXY

No-Proxy settings for the HTTP_PROXY (HTTPS_PROXY) settings in a comma separated list ("localhost,127.0.0.0/8,127.0.1.1,127.0.1.1*,...")

NUMBER_OF_PROCESSORS

public static final EnvironmentVariable NUMBER_OF_PROCESSORS

Number of processors.

PROCESSOR_ARCHITECTURE

public static final EnvironmentVariable PROCESSOR_ARCHITECTURE

Processor architecture on some systems (e.g. "AMD64").

PROCESSOR_ARCHITEW6432

public static final EnvironmentVariable PROCESSOR_ARCHITEW6432

Processor architecture on some systems (e.g. "AMD64").

STRUCT_KEEP_MAPS

public static final EnvironmentVariable STRUCT_KEEP_MAPS

When set to "true" then Map instances in data-structures are preserved instead of converting them to arrays if possible by indirectly calling StructureUtility.toDataStructure(PathMap, String) when invoking PathMap.toDataStructure().

TERM

public static final EnvironmentVariable TERM

Environment variable holding the current session's terminal.

TERMINAL_COLUMNS

public static final EnvironmentVariable TERMINAL_COLUMNS

The console width environment variable on *ix like shells.

TERMINAL_ENCODING

public static final EnvironmentVariable TERMINAL_ENCODING

Environment variable holding the current session's terminal encoding.

TERMINAL_LINES

public static final EnvironmentVariable TERMINAL_LINES

The console height environment variable.

TMPDIR

public static final EnvironmentVariable TMPDIR

TMPDIR is the canonical environment variable in Unix and POSIX that should be used to specify a temporary directory for scratch space.

USER_DIR

public static final EnvironmentVariable USER_DIR

Environment variable holding the user's current working directory path.

USER_HOME

public static final EnvironmentVariable USER_HOME

Environment variable holding the user's home folder path.

USER_NAME

public static final EnvironmentVariable USER_NAME

Environment variable holding the user's current working directory path.

Method Details

values

public static EnvironmentVariable[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EnvironmentVariable valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class 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()

Retrieves the value, first the upper-case variant of the environment variable is tried out. If not set or empty, then the lower-case variant is used.

Specified by:

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

Returns:

The value of the environment variable.

setValue

public void setValue(String aValue)

Sets the value, first the upper-case variant of the environment variable is tried out. If not set or empty, then the lower-case variant is tried.

Specified by:

setValue in interface org.refcodes.mixin.ValueAccessor.ValueMutator<String>

Parameters:

aValue - the new value