Package org.apache.commons.text.lookup

Class JavaPlatformStringLookup

java.lang.Object

org.apache.commons.text.lookup.AbstractStringLookup

org.apache.commons.text.lookup.JavaPlatformStringLookup

All Implemented Interfaces:

StringLookup

final class JavaPlatformStringLookup
extends AbstractStringLookup

Looks up keys related to Java: Java version, JRE version, VM version, and so on.

The lookup keys with examples are:

• version: "Java version 1.8.0_181"
• runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"
• vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"
• os: "Windows 10 10.0, architecture: amd64-64"
• hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"
• locale: "default locale: en_US, platform encoding: iso-8859-1"

Using a StringLookup from the StringLookupFactory:

 StringLookupFactory.INSTANCE.javaPlatformStringLookup().lookup("version");
 

Using a StringSubstitutor:

 StringSubstitutor.createInterpolator().replace("... ${java:version} ..."));
 

The above examples convert "version" to the current VM version, for example, "Java version 1.8.0_181".

Since:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static JavaPlatformStringLookup	INSTANCE	Defines the singleton for this class.

Fields inherited from class org.apache.commons.text.lookup.AbstractStringLookup

SPLIT_CH, SPLIT_STR

Method Summary

Modifier and Type	Method	Description
(package private) String	getHardware()	Accessible through the Lookup key hardware.
(package private) String	getLocale()	Accessible through the Lookup key locale.
(package private) String	getOperatingSystem()	Accessible through the Lookup key os.
(package private) String	getRuntime()	Accessible through the Lookup key runtime.
(package private) String	getVirtualMachine()	Accessible through the Lookup key vm.
String	lookup(String key)	Looks up the value of the Java platform key.
static void	main(String[] args)	The main method for running the JavaPlatformStringLookup.

Methods inherited from class org.apache.commons.text.lookup.AbstractStringLookup

substringAfter, substringAfter, substringAfterLast, toLookupKey, toLookupKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

static final JavaPlatformStringLookup INSTANCE

Defines the singleton for this class.

Method Detail

main

public static void main(String[] args)

The main method for running the JavaPlatformStringLookup.

Parameters:

args - the standard java main method parameter which is unused for our running of this class.

getHardware

String getHardware()

Accessible through the Lookup key hardware.

Returns:

hardware processor information.

getLocale

String getLocale()

Accessible through the Lookup key locale.

Returns:

system locale and file encoding information.

getOperatingSystem

String getOperatingSystem()

Accessible through the Lookup key os.

Returns:

operating system information.

getRuntime

String getRuntime()

Accessible through the Lookup key runtime.

Returns:

Java Runtime Environment information.

getVirtualMachine

String getVirtualMachine()

Accessible through the Lookup key vm.

Returns:

Java Virtual Machine information.

lookup

public String lookup(String key)

Looks up the value of the Java platform key.

The lookup keys with examples are:

• version: "Java version 1.8.0_181"
• runtime: "Java(TM) SE Runtime Environment (build 1.8.0_181-b13) from Oracle Corporation"
• vm: "Java HotSpot(TM) 64-Bit Server VM (build 25.181-b13, mixed mode)"
• os: "Windows 10 10.0, architecture: amd64-64"
• hardware: "processors: 4, architecture: amd64-64, instruction sets: amd64"
• locale: "default locale: en_US, platform encoding: iso-8859-1"

Parameters:

key - the key to be looked up, may be null

Returns:

The value of the environment variable.