core/com.hexagontk.core/Platform

Platform

object Platform

Object with utilities to gather information about the running platform.

Properties

charset

val charset: Charset

Default character set.

console

val console: Console

JVM Console, if the program don't have a console (i.e.: input or output redirected), an exception is thrown.

cpuCount

val cpuCount: Int

Number of processors available to the Java virtual machine.

hostName

val hostName: String

The host name of the machine running this program.

val ip: String

The IP address of the machine running this program.

isConsole

val isConsole: Boolean

True if the program has a console (terminal, TTY, PTY...), false if I/O is piped.

locale

val locale: Locale

Default locale for this instance of the Java Virtual Machine.

localeCode

val localeCode: String

User locale consist of 2-letter language code, 2-letter country code and file encoding.

name

val name: String

Name of the JVM running this program. For example: OpenJDK 64-Bit Server VM.

val os: String

Operating system name ('os.name' property). If null throws an exception.

osKind

val osKind: OsKind

Operating system type.

pid

val pid: Long

OS Process ID.

runtime

val runtime: Runtime

Current JVM runtime.

timeZone

val timeZone: TimeZone

Default timezone.

version

val version: String

Java version aka language level. For example: 11

zoneId

val zoneId: ZoneId

Default zone ID.

Functions

loadSystemSettings

fun loadSystemSettings(settings: Map<String, String>)

Add a map to system properties, overriding entries if already set.

systemFlag

fun systemFlag(name: String): Boolean

Retrieve a flag (boolean parameter) by name by looking in OS environment variables first and in the JVM system properties if not found.

systemSetting

inline fun <T : Any> systemSetting(name: String): T

inline fun <T : Any> systemSetting(name: String, defaultValue: T): T

fun <T : Any> systemSetting(type: KClass<T>, name: String): T

fun <T : Any> systemSetting(type: KClass<T>, name: String, defaultValue: T): T

systemSettingOrNull

inline fun <T : Any> systemSettingOrNull(name: String): T?

Utility method for retrieving a system setting, check systemSettingOrNull for details.

fun <T : Any> systemSettingOrNull(type: KClass<T>, name: String): T?

Retrieve a setting by name by looking in OS environment variables first and in the JVM system properties if not found.

totalMemory

fun totalMemory(): String

Amount of memory in kilobytes available to the JVM.

uptime

fun uptime(): Long

Milliseconds since the process was created.

usedMemory

fun usedMemory(): String

Amount of used memory in kilobytes.