eu.fthevenet.binjr.preferences

Class AppEnvironment

java.lang.Object

eu.fthevenet.binjr.preferences.AppEnvironment

public class AppEnvironment
extends java.lang.Object

Provides access to the application's environmental properties

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	consoleVisible
javafx.beans.property.BooleanProperty	debugMode
javafx.beans.property.Property<org.apache.logging.log4j.Level>	logLevel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT_NOTICE
static java.lang.String	HTTP_BINJR_WIKI
static java.lang.String	HTTP_GITHUB_REPO
static java.lang.String	HTTP_WWW_BINJR_EU
static java.lang.String	LICENSE

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.BooleanProperty	consoleVisibleProperty()
javafx.beans.property.BooleanProperty	debugModeProperty()
java.lang.String	getAppDescription() Returns a short description for the application.
java.lang.Long	getBuildNumber() Returns the build number from the manifest
static AppEnvironment	getInstance() Get the singleton instance for the UpdateManager class.
org.apache.logging.log4j.Level	getLogLevel() Gets the value of the property logLevel.
java.util.jar.Manifest	getManifest()
java.util.jar.Manifest	getManifest(java.lang.Class<?> aClass) Returns the manifest for the JAR which packages the specified class.
OsFamily	getOsFamily() Returns the family of the currently running OS
java.util.List<SysInfoProperty>	getSysInfoProperties() Returns a list of system properties
Version	getVersion() Returns the version information held in the containing jar's manifest
Version	getVersion(java.lang.Class aClass)
Version	getVersion(java.util.jar.Manifest manifest) Returns a version number extracted from the specified manifest.
boolean	isConsoleVisible() Gets the value of the property consoleVisible.
boolean	isDebugMode() Gets the value of the property debugMode.
javafx.beans.property.Property<org.apache.logging.log4j.Level>	logLevelProperty()
void	setConsoleVisible(boolean consoleVisible) Sets the value of the property consoleVisible.
void	setDebugMode(boolean value) Sets the value of the property debugMode.
void	setLogLevel(org.apache.logging.log4j.Level logLevel) Sets the value of the property logLevel.

Methods inherited from class java.lang.Object

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

Property Detail

debugMode

public javafx.beans.property.BooleanProperty debugModeProperty

See Also:

isDebugMode(), setDebugMode(boolean)

consoleVisible

public javafx.beans.property.BooleanProperty consoleVisibleProperty

See Also:

isConsoleVisible(), setConsoleVisible(boolean)

logLevel

public javafx.beans.property.Property<org.apache.logging.log4j.Level> logLevelProperty

See Also:

getLogLevel(), setLogLevel(Level)

Field Detail

HTTP_GITHUB_REPO

public static final java.lang.String HTTP_GITHUB_REPO

See Also:

Constant Field Values

HTTP_WWW_BINJR_EU

public static final java.lang.String HTTP_WWW_BINJR_EU

See Also:

Constant Field Values

HTTP_BINJR_WIKI

public static final java.lang.String HTTP_BINJR_WIKI

See Also:

Constant Field Values

COPYRIGHT_NOTICE

public static final java.lang.String COPYRIGHT_NOTICE

See Also:

Constant Field Values

LICENSE

public static final java.lang.String LICENSE

See Also:

Constant Field Values

Method Detail

getInstance

public static AppEnvironment getInstance()

Get the singleton instance for the UpdateManager class.

Returns:

the singleton instance for the UpdateManager class.

getVersion

public Version getVersion()

Returns the version information held in the containing jar's manifest

Returns:

the version information held in the containing jar's manifest

getVersion

public Version getVersion(java.util.jar.Manifest manifest)

Returns a version number extracted from the specified manifest.

The version number is extracted according to the following rules:

• If the key Specification-Version is present and can be formatted as valid Version instance then it is returned, else
• If the key Implementation-Version is present and can be formatted as valid Version instance then it is returned, else
• Version.emptyVersion is returned

Parameters:

manifest - the Manifest from which a version number should be extracted.

Returns:

a version number extracted from the specified manifest.

getVersion

public Version getVersion(java.lang.Class aClass)

getManifest

public java.util.jar.Manifest getManifest()

getManifest

public java.util.jar.Manifest getManifest(java.lang.Class<?> aClass)

Returns the manifest for the JAR which packages the specified class.

Parameters:

aClass -

Returns:

the manifest for the JAR which packages the specified class.

getAppDescription

public java.lang.String getAppDescription()

Returns a short description for the application.

Returns:

a short description for the application.

getBuildNumber

public java.lang.Long getBuildNumber()

Returns the build number from the manifest

Returns:

the build number from the manifest

getSysInfoProperties

public java.util.List<SysInfoProperty> getSysInfoProperties()

Returns a list of system properties

Returns:

a list of system properties

getOsFamily

public OsFamily getOsFamily()

Returns the family of the currently running OS

Returns:

the family of the currently running OS

setDebugMode

public void setDebugMode(boolean value)

Sets the value of the property debugMode.

isDebugMode

public boolean isDebugMode()

Gets the value of the property debugMode.

debugModeProperty

public javafx.beans.property.BooleanProperty debugModeProperty()

See Also:

isDebugMode(), setDebugMode(boolean)

isConsoleVisible

public boolean isConsoleVisible()

Gets the value of the property consoleVisible.

consoleVisibleProperty

public javafx.beans.property.BooleanProperty consoleVisibleProperty()

See Also:

isConsoleVisible(), setConsoleVisible(boolean)

setConsoleVisible

public void setConsoleVisible(boolean consoleVisible)

Sets the value of the property consoleVisible.

getLogLevel

public org.apache.logging.log4j.Level getLogLevel()

Gets the value of the property logLevel.

logLevelProperty

public javafx.beans.property.Property<org.apache.logging.log4j.Level> logLevelProperty()

See Also:

getLogLevel(), setLogLevel(Level)

setLogLevel

public void setLogLevel(org.apache.logging.log4j.Level logLevel)

Sets the value of the property logLevel.