- 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 extends Object,
B extends org.refcodes.mixin.KeyAccessor.KeyBuilder<K, B>>, org.refcodes.mixin.KeyAccessor.KeyMutator<K extends Object>, org.refcodes.mixin.KeyAccessor.KeyProperty<K extends Object> Nested classes/interfaces inherited from interface org.refcodes.mixin.ValueAccessor
org.refcodes.mixin.ValueAccessor.ValueBuilder<V extends Object,
B extends org.refcodes.mixin.ValueAccessor.ValueBuilder<V, B>>, org.refcodes.mixin.ValueAccessor.ValueMutator<V extends Object>, org.refcodes.mixin.ValueAccessor.ValueProperty<V extends Object> -
Enum Constant Summary
Enum ConstantDescriptionThe virtual and the physical console width height and environment variable.The environment variable (on windows) holding the computer's name.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.ConEmu's environment variable regarding ANSI support.Stands for the lines per column to be taken by REFCODES.ORG artifacts.The console's line-break property.Stands for the chars per row to be taken by REFCODES.ORG artifacts.Environment variable "HOST_SEED" for the Host-Seed for host-related IDs.The environment variable (on windows) holding the computer's name.HTTP-Proxy setting in URL notation ("http://my.company.org:3128")HTTPS-Proxy setting in URL notation ("http://my.company.org:3128")LANG is the normal environment variable for specifying a locale.Stands for the chosen layout for the REFCODES.ORG logger artifacts.Stands for the chosen style for the REFCODES.ORG logger artifacts.No-Proxy settings for theHTTP_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.Processor architecture on some systems (e.g.Processor architecture on some systems (e.g.Environment variable holding the current session's terminal.The console width environment variable on *ix like shells.Environment variable holding the current session's terminal encoding.The console height environment variable.TMPDIR is the canonical environment variable in Unix and POSIX that should be used to specify a temporary directory for scratch space.Environment variable holding the user's current working directory path.Environment variable holding the user's home folder path.Environment variable holding the user's current working directory path. -
Method Summary
Modifier and TypeMethodDescriptiongetKey()
getValue()
Retrieves the value, first the upper-case variant of the environment variable is tried out.void
Sets the value, first the upper-case variant of the environment variable is tried out.static EnvironmentVariable
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 interface org.refcodes.mixin.ValueAccessor
getValueOr
Methods inherited from interface org.refcodes.mixin.ValueAccessor.ValueProperty
letValue
-
Enum Constant Details
-
ANSICON
The virtual and the physical console width height and environment variable. E.g. ANSICON=80x19999 (80x25) -
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. Used to override any default line breaks for the REFCODES-ORG artifacts. -
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 theHTTP_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. "AMD64"). -
PROCESSOR_ARCHITEW6432
Processor architecture on some systems (e.g. "AMD64"). -
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 Details
-
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
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 nameNullPointerException
- if the argument is null
-
getKey
- Specified by:
getKey
in interfaceorg.refcodes.mixin.KeyAccessor<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 interfaceorg.refcodes.mixin.ValueAccessor<String>
- Returns:
- The value of the environment variable.
-
setValue
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 interfaceorg.refcodes.mixin.ValueAccessor.ValueMutator<String>
- Parameters:
aValue
- the new value
-