Enum Class SystemProperty

java.lang.Object

java.lang.Enum<SystemProperty>

org.refcodes.runtime.SystemProperty

All Implemented Interfaces:

Serializable, Comparable<SystemProperty>, Constable, EnabledAccessor, EnabledAccessor.EnabledMutator, EnabledAccessor.EnabledProperty, KeyAccessor<String>, ValueAccessor<String>, ValueAccessor.ValueMutator<String>, ValueAccessor.ValueProperty<String>

public enum SystemProperty
extends Enum<SystemProperty>
implements KeyAccessor<String>, ValueAccessor.ValueProperty<String>, EnabledAccessor.EnabledProperty

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 class Enum

Enum.EnumDesc<E>

Nested classes/interfaces inherited from interface EnabledAccessor

EnabledAccessor.EnabledBuilder<B>, EnabledAccessor.EnabledMutator, EnabledAccessor.EnabledProperty

Nested classes/interfaces inherited from interface KeyAccessor

KeyAccessor.KeyBuilder<K,B>, KeyAccessor.KeyMutator<K>, KeyAccessor.KeyProperty<K>

Nested classes/interfaces inherited from interface ValueAccessor

ValueAccessor.ValueBuilder<V,B>, ValueAccessor.ValueMutator<V>, ValueAccessor.ValueProperty<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARGS_FILTER	When set, then the ArgsFilter from artifact refcodes-cli (of group org.refcodes) with the according propertie's value is applied when parsing command line arguments via the org.refcodes command line parser (any implementation of the ArgsParser type).
ARGS_NOTATION	When set, then the SyntaxNotation from artifact refcodes-cli (of group org.refcodes) with the according propertie's value is applied when parsing command line arguments via the org.refcodes command line parser (any implementation of the ArgsParser type).
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.ini" file).
CONSOLE_ANSI	Pass as JVM argument via -Dconsole.ansi=<true|false> where "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_HEIGHT	Pass as JVM argument via "-Dconsole.height=n" (where n stands for the number of lines).
CONSOLE_LINE_BREAK	The console's line-break property.
CONSOLE_WIDTH	Pass as JVM argument via "-Dconsole.width=n" (where n stands for the number of chars per row).
DOCUMENT_ARRAY_INDEX	When set to true, then marshaling (XML) documents will preserve array index information by using an index attribute for array elements in the produced XML.
DOCUMENT_ENVELOPE	When set to true, then unmarshaling (XML) documents will preserve the preserve the root element (envelope) when even when merely acting as an envelope.
DOCUMENT_PRESERVE_EMPTY	When set to true, then unmarshaling (XML) documents will preserve empty elements, e.g. when parsing XML.
FILE_ENCODING	The OS specific file encoding is retrieved by this system property.
FILE_SEPARATOR	The OS specific file separator is retrieved by this system property.
HOST_SEED	System property "host.seed" for the Host-Seed for host-related IDs.
HTTP_NON_PROXY_HOSTS	No-Proxy settings for the HTTP_PROXY_HOST (HTTP_PROXY_PORT) settings in a comma separated list ("localhost,127.0.0.0/8,127.0.1.1,127.0.1.1*,...")
HTTP_PROXY_HOST	HTTP-Proxy host without a port ("http://my.company.org")
HTTP_PROXY_PORT	HTTP-Proxy port ("3128")
HTTPS_NON_PROXY_HOSTS	No-Proxy settings for the HTTPS_PROXY_HOST (HTTPS_PROXY_PORT) settings in a comma separated list ("localhost,127.0.0.0/8,127.0.1.1,127.0.1.1*,...")
HTTPS_PROXY_HOST	HTTPS-Proxy host without a port ("http://my.company.org")
HTTPS_PROXY_PORT	HTTP-Proxy port ("3128")
JAVA_AWT_HEADLESS	To set up headless mode, set the appropriate system property ("https://www.oracle.com/technetwork/articles/javase/headless-136834.html").
KEY_STORE_FILE	Location of the Java keystore file containing an application process's own certificate and private key.
KEY_STORE_PASSWORD	Password to access the private key from the keystore file specified by KEY_STORE_FILE.
KEY_STORE_TYPE	For Java keystore file format, this property has the value "jks" (or "JKS").
LAUNCHER_DIR	Specifies the path to your application's launcher dir, e.g. the place where your JAR resides in.
LINE_SEPARATOR	Sequence used by operating system to separate lines in text files.
LOG_DEBUG	When isEnabled(), then additional REFCODES.ORG artifacts' debug information may be logged.
LOG_TESTS	When isEnabled(), then REFCODES.ORG artifacts' unit tests are (more) verbose,
LOGGER_LAYOUT	Pass as JVM argument via "-Dlogger.layout=<layout>" (where <layout> stands for the chosen layout for the REFCODES.ORG logger artifacts.).
LOGGER_STYLE	Pass as JVM argument via "-Dlogger.style=<style>" (where <style> stands for the chosen logger-style for the REFCODES.ORG logger artifacts.)
NATIVE_IMAGE_CODE	Holds the string that is the name of the system property providing information about the context in which code is currently executing.
NATIVE_IMAGE_KIND	Name of the system property that holds if this image is built as a shared library or an executable.
OPERATING_SYSTEM_NAME	Operating system name.
OPERATING_SYSTEM_VERSION	Operating system name.
OS_ARCH	Processor architecture on some systems (e.g.
OS_NAME	OS Name, might be something like "Linux" or "Windows"
PROCESS_ID	At least set on Ubuntu-Linux:.
SOCKS_PROXY_HOST	SOCKS-Proxy host without a port ("http://my.company.org")
SOCKS_PROXY_PORT	SOCKS-Proxy port ("3128")
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(ImmutablePathTable, String) when invoking ImmutablePathTable.toDataStructure().
TEMP_DIR	The OS specific temp folder path.
TRUST_STORE_FILE	Location of the Java keystore file containing the collection of CA certificates trusted by this application process (trust store).
TRUST_STORE_PASSWORD	Password to unlock the keystore file (store password) specified by TRUST_STORE_FILE.
TRUST_STORE_TYPE	For Java keystore file format, this property has the value "jks" (or "JKS").
USER_COUNTRY	System variable holding the user's login name.
USER_DIR	System variable holding the user's current working directory.
USER_HOME	System variable holding the user's home folder path.
USER_LANGUAGE	System variable holding the user's login name.
USER_NAME	System variable holding the user's login name.

Method Summary

Modifier and Type	Method	Description
String	getKey()
String	getValue()
boolean	isEnabled()
boolean	isEnabledOr(boolean aDefaultValue)	Returns the value for the property if present or if the default value if there is no such property.
void	setEnabled(boolean isEnabled)
void	setValue(String aValue)
static String	toPropertyValue(String aDefaultValue, SystemProperty aSystemProperty, EnvironmentVariable... aEnvironmentProperties)	Gets the value for the provided properties, if non was found then the default value is taken.
static String	toPropertyValue(SystemProperty aSystemProperty, EnvironmentVariable... aEnvironmentProperties)	Gets the value for the provided properties, if non was found then null is returned.
static String	toSystemPropertyName(String aKey)	Converts the given key into a JVM system property name.
static SystemProperty	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SystemProperty[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface EnabledAccessor.EnabledProperty

letEnabled

Methods inherited from interface ValueAccessor

getValueOr, hasValue

Methods inherited from interface ValueAccessor.ValueProperty

letValue

Enum Constant Details

LOG_TESTS

public static final SystemProperty LOG_TESTS

When isEnabled(), then REFCODES.ORG artifacts' unit tests are (more) verbose,

LOG_DEBUG

public static final SystemProperty LOG_DEBUG

When isEnabled(), then additional REFCODES.ORG artifacts' debug information may be logged.

ARGS_FILTER

public static final SystemProperty ARGS_FILTER

When set, then the ArgsFilter from artifact refcodes-cli (of group org.refcodes) with the according propertie's value is applied when parsing command line arguments via the org.refcodes command line parser (any implementation of the ArgsParser type).

Values as of the ArgsFilter enumeration may be D, XX, D_XX or NONE.

ARGS_NOTATION

public static final SystemProperty ARGS_NOTATION

When set, then the SyntaxNotation from artifact refcodes-cli (of group org.refcodes) with the according propertie's value is applied when parsing command line arguments via the org.refcodes command line parser (any implementation of the ArgsParser type).

Values as of the SyntaxNotation enumeration may be LOGICAL, GNU_POSIX, WINDOWS or DESCRIPTION.

NATIVE_IMAGE_CODE

public static final SystemProperty NATIVE_IMAGE_CODE

Holds the string that is the name of the system property providing information about the context in which code is currently executing. If the property returns the string given by ImageInfo.PROPERTY_IMAGE_CODE_VALUE_BUILDTIME the code is executing in the context of image building (e.g. in a static initializer of a class that will be contained in the image). If the property returns the string given by ImageInfo.PROPERTY_IMAGE_CODE_VALUE_RUNTIME the code is executing at image runtime. Otherwise the property is not set.

Holds the string that will be returned by the system property for ImageInfo.PROPERTY_IMAGE_CODE_KEY if code is executing in the context of image building (e.g. in a static initializer of class that will be contained in the image).

• PROPERTY_IMAGE_CODE_VALUE_BUILDTIME = "buildtime"
• PROPERTY_IMAGE_CODE_VALUE_RUNTIME = "runtime"

See also https://www.graalvm.org/sdk/javadoc/constant-values.html

NATIVE_IMAGE_KIND

public static final SystemProperty NATIVE_IMAGE_KIND

Name of the system property that holds if this image is built as a shared library or an executable. If the property is ImageInfo.PROPERTY_IMAGE_KIND_VALUE_EXECUTABLE the image is built as an executable. If the property is ImageInfo.PROPERTY_IMAGE_KIND_VALUE_SHARED_LIBRARY the image is built as a shared library.

• PROPERTY_IMAGE_KIND_VALUE_EXECUTABLE = "executable"
• PROPERTY_IMAGE_KIND_VALUE_SHARED_LIBRARY = "shared"

See also https://www.graalvm.org/sdk/javadoc/constant-values.html

JAVA_AWT_HEADLESS

public static final SystemProperty JAVA_AWT_HEADLESS

To set up headless mode, set the appropriate system property ("https://www.oracle.com/technetwork/articles/javase/headless-136834.html").

HTTP_PROXY_HOST

public static final SystemProperty HTTP_PROXY_HOST

HTTP-Proxy host without a port ("http://my.company.org")

HTTP_PROXY_PORT

public static final SystemProperty HTTP_PROXY_PORT

HTTP-Proxy port ("3128")

HTTPS_PROXY_HOST

public static final SystemProperty HTTPS_PROXY_HOST

HTTPS-Proxy host without a port ("http://my.company.org")

HTTPS_PROXY_PORT

public static final SystemProperty HTTPS_PROXY_PORT

HTTP-Proxy port ("3128")

SOCKS_PROXY_HOST

public static final SystemProperty SOCKS_PROXY_HOST

SOCKS-Proxy host without a port ("http://my.company.org")

SOCKS_PROXY_PORT

public static final SystemProperty SOCKS_PROXY_PORT

SOCKS-Proxy port ("3128")

STRUCT_KEEP_MAPS

public static final SystemProperty 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(ImmutablePathTable, String) when invoking ImmutablePathTable.toDataStructure().

HOST_SEED

public static final SystemProperty HOST_SEED

System property "host.seed" for the Host-Seed for host-related IDs.

HTTP_NON_PROXY_HOSTS

public static final SystemProperty HTTP_NON_PROXY_HOSTS

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

HTTPS_NON_PROXY_HOSTS

public static final SystemProperty HTTPS_NON_PROXY_HOSTS

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

OS_ARCH

public static final SystemProperty OS_ARCH

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

OS_NAME

public static final SystemProperty OS_NAME

OS Name, might be something like "Linux" or "Windows"

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.ini" file).

FILE_SEPARATOR

public static final SystemProperty FILE_SEPARATOR

The OS specific file separator is retrieved by this system property.

FILE_ENCODING

public static final SystemProperty FILE_ENCODING

The OS specific file encoding is retrieved by this system property.

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

Sequence used by operating system to separate lines in text files.

OPERATING_SYSTEM_NAME

public static final SystemProperty OPERATING_SYSTEM_NAME

Operating system name.

OPERATING_SYSTEM_VERSION

public static final SystemProperty OPERATING_SYSTEM_VERSION

Operating system name.

LAUNCHER_DIR

public static final SystemProperty LAUNCHER_DIR

Specifies the path to your application's launcher dir, e.g. the place where your JAR resides in. Pass as JVM argument via "-Dlauncher.dir=/path/to/launcher/dir".

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).

CONSOLE_ANSI

public static final SystemProperty CONSOLE_ANSI

Pass as JVM argument via -Dconsole.ansi=<true|false> where "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_LINE_BREAK

public static final SystemProperty CONSOLE_LINE_BREAK

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

LOGGER_LAYOUT

public static final SystemProperty LOGGER_LAYOUT

Pass as JVM argument via "-Dlogger.layout=<layout>" (where <layout> stands for the chosen layout for the REFCODES.ORG logger artifacts.).

LOGGER_STYLE

public static final SystemProperty LOGGER_STYLE

Pass as JVM argument via "-Dlogger.style=<style>" (where <style> stands for the chosen logger-style for the REFCODES.ORG logger artifacts.) (see org.refcodes.textual.TextBoxStyle).

USER_HOME

public static final SystemProperty USER_HOME

System variable holding the user's home folder path.

USER_NAME

public static final SystemProperty USER_NAME

System variable holding the user's login name.

USER_LANGUAGE

public static final SystemProperty USER_LANGUAGE

System variable holding the user's login name.

USER_COUNTRY

public static final SystemProperty USER_COUNTRY

System variable holding the user's login name.

USER_DIR

public static final SystemProperty USER_DIR

System variable holding the user's current working directory.

KEY_STORE_FILE

public static final SystemProperty KEY_STORE_FILE

Location of the Java keystore file containing an application process's own certificate and private key.

KEY_STORE_PASSWORD

public static final SystemProperty KEY_STORE_PASSWORD

Password to access the private key from the keystore file specified by KEY_STORE_FILE.

KEY_STORE_TYPE

public static final SystemProperty KEY_STORE_TYPE

For Java keystore file format, this property has the value "jks" (or "JKS"). Its default value is already "jks".

TRUST_STORE_FILE

public static final SystemProperty TRUST_STORE_FILE

Location of the Java keystore file containing the collection of CA certificates trusted by this application process (trust store).

TRUST_STORE_PASSWORD

public static final SystemProperty TRUST_STORE_PASSWORD

Password to unlock the keystore file (store password) specified by TRUST_STORE_FILE.

TRUST_STORE_TYPE

public static final SystemProperty TRUST_STORE_TYPE

For Java keystore file format, this property has the value "jks" (or "JKS"). Its default value is already "jks".

DOCUMENT_ENVELOPE

public static final SystemProperty DOCUMENT_ENVELOPE

When set to true, then unmarshaling (XML) documents will preserve the preserve the root element (envelope) when even when merely acting as an envelope. As an (XML) document requires a root element, the root element often is provided merely as of syntactic reasons and must be omitted as of semantic reasons. Unmarshaling functionality therefore may by default skip the root elelemt, as this is considered merely to serve as an envelope. This behavior can be overridden by setting this property to true.

DOCUMENT_ARRAY_INDEX

public static final SystemProperty DOCUMENT_ARRAY_INDEX

When set to true, then marshaling (XML) documents will preserve array index information by using an index attribute for array elements in the produced XML.

DOCUMENT_PRESERVE_EMPTY

public static final SystemProperty DOCUMENT_PRESERVE_EMPTY

When set to true, then unmarshaling (XML) documents will preserve empty elements, e.g. when parsing XML.

Method Details

values

public static SystemProperty[] 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 SystemProperty 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 KeyAccessor<String>

getValue

public String getValue()

Specified by:

getValue in interface ValueAccessor<String>

setValue

public void setValue(String aValue)

Specified by:

setValue in interface ValueAccessor.ValueMutator<String>

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface EnabledAccessor

isEnabledOr

public boolean isEnabledOr(boolean aDefaultValue)

Returns the value for the property if present or if the default value if there is no such property.

Parameters:

aDefaultValue - The default value to take when no property was present.

Returns:

The value of the property if present or the default value.

setEnabled

public void setEnabled(boolean isEnabled)

Specified by:

setEnabled in interface EnabledAccessor.EnabledMutator

toPropertyValue

public static String toPropertyValue(String aDefaultValue,
 SystemProperty aSystemProperty,
 EnvironmentVariable... aEnvironmentProperties)

Gets the value for the provided properties, if non was found then the default value is taken. A SystemProperty elements wins over the EnvironmentVariable elements. The preceding EnvironmentVariable element wins over the succeeding EnvironmentVariable element. The default value is taken if non property had a value (a String with length > 0).

Parameters:

aDefaultValue - The default value to take when none other value was set.

aSystemProperty - The system-property passed via java -D<name>=<value>

aEnvironmentProperties - The properties looked for in the system's environment variables.

Returns:

The best fitting value.

toPropertyValue

public static String toPropertyValue(SystemProperty aSystemProperty,
 EnvironmentVariable... aEnvironmentProperties)

Gets the value for the provided properties, if non was found then null is returned. A SystemProperty elements wins over the EnvironmentVariable elements. The preceding EnvironmentVariable element wins over the succeeding EnvironmentVariable element. A null is taken if non property had a value (a String with length > 0).

Parameters:

aSystemProperty - The system-property passed via java -D<name>=<value>

aEnvironmentProperties - The properties looked for in the system's environment variables.

Returns:

The best fitting value or null if none was detected.

toSystemPropertyName

public static String toSystemPropertyName(String aKey)

Converts the given key into a JVM system property name.

The conversion transforms the key into a lower-case, dot-separated form. Word boundaries in camel-case identifiers are converted to dot separators, existing underscore characters are replaced by dots, and the resulting name is converted to lower case.

This convention follows common JVM system property naming practices and allows configuration values to be supplied consistently via -D command line arguments.

Parameters:

aKey - The key to be converted.

Returns:

The corresponding system property name.