- All Implemented Interfaces:
Serializable
,Comparable<SystemProperty>
,Constable
,org.refcodes.mixin.EnabledAccessor
,org.refcodes.mixin.EnabledAccessor.EnabledMutator
,org.refcodes.mixin.EnabledAccessor.EnabledProperty
,org.refcodes.mixin.KeyAccessor<String>
,org.refcodes.mixin.ValueAccessor<String>
,org.refcodes.mixin.ValueAccessor.ValueMutator<String>
,org.refcodes.mixin.ValueAccessor.ValueProperty<String>
public enum SystemProperty
extends Enum<SystemProperty>
implements org.refcodes.mixin.KeyAccessor<String>, org.refcodes.mixin.ValueAccessor.ValueProperty<String>, org.refcodes.mixin.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 java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Nested classes/interfaces inherited from interface org.refcodes.mixin.EnabledAccessor
org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B extends org.refcodes.mixin.EnabledAccessor.EnabledBuilder<B>>, org.refcodes.mixin.EnabledAccessor.EnabledMutator, org.refcodes.mixin.EnabledAccessor.EnabledProperty
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 ConstantDescriptionWhen set, then theArgsFilter
from artifactrefcodes-cli
(of grouporg.refcodes
) with the according propertie's value is applied when parsing command line arguments via theorg.refcodes
command line parser (any implementation of theArgsParser
type).When set, then theSyntaxNotation
from artifactrefcodes-cli
(of grouporg.refcodes
) with the according propertie's value is applied when parsing command line arguments via theorg.refcodes
command line parser (any implementation of theArgsParser
type).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).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.Pass as JVM argument via "-Dconsole.height=n" (where n stands for the number of lines).The console's line-break property.Pass as JVM argument via "-Dconsole.width=n" (where n stands for the number of chars per row).The OS specific file encoding is retrieved by this system property.The OS specific file separator is retrieved by this system property.Holds the string that is the name of the system property providing information about the context in which code is currently executing.System property "host.seed" for the Host-Seed for host-related IDs.No-Proxy settings for theHTTP_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 without a port ("http://my.company.org")HTTP-Proxy port ("3128")No-Proxy settings for theHTTPS_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 without a port ("http://my.company.org")HTTP-Proxy port ("3128")To set up headless mode, set the appropriate system property ("https://www.oracle.com/technetwork/articles/javase/headless-136834.html").Location of the Java keystore file containing an application process's own certificate and private key.Password to access the private key from the keystore file specified byKEY_STORE_FILE
.For Java keystore file format, this property has the value "jks" (or "JKS").Specifies the path to your application's launcher dir, e.g. the place where your JAR resides in.Sequence used by operating system to separate lines in text files.WhenisEnabled()
, then additional REFCODES.ORG artifacts' debug information may be logged.WhenisEnabled()
, then REFCODES.ORG artifacts' unit tests are (more) verbose,Pass as JVM argument via "-Dlogger.layout=<layout>
" (where<layout>
stands for the chosen layout for the REFCODES.ORG logger artifacts.).Pass as JVM argument via "-Dlogger.style=<style>
" (where<style>
stands for the chosen logger-style for the REFCODES.ORG logger artifacts.)Operating system name.Operating system name.Processor architecture on some systems (e.g.OS Name, might be something like "Linux" or "Windows"At least set on Ubuntu-Linux:.SOCKS-Proxy host without a port ("http://my.company.org")SOCKS-Proxy port ("3128")The OS specific temp folder path.Location of the Java keystore file containing the collection of CA certificates trusted by this application process (trust store).Password to unlock the keystore file (store password) specified byTRUST_STORE_FILE
.For Java keystore file format, this property has the value "jks" (or "JKS").System variable holding the user's login name.System variable holding the user's current working directory.System variable holding the user's home folder path.System variable holding the user's login name.System variable holding the user's login name. -
Method Summary
Modifier and TypeMethodDescriptiongetKey()
getValue()
boolean
void
setEnabled
(boolean isEnabled) void
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 SystemProperty
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 java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from interface org.refcodes.mixin.EnabledAccessor.EnabledProperty
letEnabled
Methods inherited from interface org.refcodes.mixin.ValueAccessor
getValueOr
Methods inherited from interface org.refcodes.mixin.ValueAccessor.ValueProperty
letValue
-
Enum Constant Details
-
LOG_TEST
WhenisEnabled()
, then REFCODES.ORG artifacts' unit tests are (more) verbose, -
LOG_DEBUG
WhenisEnabled()
, then additional REFCODES.ORG artifacts' debug information may be logged. -
ARGS_FILTER
When set, then theArgsFilter
from artifactrefcodes-cli
(of grouporg.refcodes
) with the according propertie's value is applied when parsing command line arguments via theorg.refcodes
command line parser (any implementation of theArgsParser
type). Values as of theArgsFilter
enumeration may beD
,XX
,D_XX
orNONE
. -
ARGS_NOTATION
When set, then theSyntaxNotation
from artifactrefcodes-cli
(of grouporg.refcodes
) with the according propertie's value is applied when parsing command line arguments via theorg.refcodes
command line parser (any implementation of theArgsParser
type). Values as of theSyntaxNotation
enumeration may beLOGICAL
,GNU_POSIX
,WINDOWS
orVERBOSE
. -
GRAALVM_IMAGE_CODE_KEY
Holds the string that is the name of the system property providing information about the context in which code is currently executing. Being "buildtime" 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). Being "runtime" if code is executing at image runtime. -
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
HTTP-Proxy host without a port ("http://my.company.org") -
HTTP_PROXY_PORT
HTTP-Proxy port ("3128") -
HTTPS_PROXY_HOST
HTTPS-Proxy host without a port ("http://my.company.org") -
HTTPS_PROXY_PORT
HTTP-Proxy port ("3128") -
SOCKS_PROXY_HOST
SOCKS-Proxy host without a port ("http://my.company.org") -
SOCKS_PROXY_PORT
SOCKS-Proxy port ("3128") -
HOST_SEED
System property "host.seed" for the Host-Seed for host-related IDs. -
HTTP_NON_PROXY_HOSTS
No-Proxy settings for theHTTP_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
No-Proxy settings for theHTTPS_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
Processor architecture on some systems (e.g. "AMD64"). -
OS_NAME
OS Name, might be something like "Linux" or "Windows" -
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
The OS specific file separator is retrieved by this system property. -
FILE_ENCODING
The OS specific file encoding is retrieved by this system property. -
TEMP_DIR
The OS specific temp folder path. -
PROCESS_ID
At least set on Ubuntu-Linux:. -
LINE_SEPARATOR
Sequence used by operating system to separate lines in text files. -
OPERATING_SYSTEM_NAME
Operating system name. -
OPERATING_SYSTEM_VERSION
Operating system name. -
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
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). -
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
The console's line-break property. Used to override any default line breaks for the REFCODES-ORG artifacts. -
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.) (seeorg.refcodes.textual.TextBoxStyle
). -
USER_HOME
System variable holding the user's home folder path. -
USER_NAME
System variable holding the user's login name. -
USER_LANGUAGE
System variable holding the user's login name. -
USER_COUNTRY
System variable holding the user's login name. -
USER_DIR
System variable holding the user's current working directory. -
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 byKEY_STORE_FILE
. -
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
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 byTRUST_STORE_FILE
. -
TRUST_STORE_TYPE
For Java keystore file format, this property has the value "jks" (or "JKS"). Its default value is already "jks".
-
-
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
- Specified by:
getValue
in interfaceorg.refcodes.mixin.ValueAccessor<String>
-
setValue
- Specified by:
setValue
in interfaceorg.refcodes.mixin.ValueAccessor.ValueMutator<String>
-
isEnabled
public boolean isEnabled()- Specified by:
isEnabled
in interfaceorg.refcodes.mixin.EnabledAccessor
-
setEnabled
public void setEnabled(boolean isEnabled) - Specified by:
setEnabled
in interfaceorg.refcodes.mixin.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. ASystemProperty
elements wins over theEnvironmentVariable
elements. The precedingEnvironmentVariable
element wins over the succeedingEnvironmentVariable
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 viajava -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. ASystemProperty
elements wins over theEnvironmentVariable
elements. The precedingEnvironmentVariable
element wins over the succeedingEnvironmentVariable
element. A null is taken if non property had a value (a String with length > 0).- Parameters:
aSystemProperty
- The system-property passed viajava -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.
-