Package com.inductiveautomation.ignition.client.launch.util

Class LaunchSysProp<T>

java.lang.Object

com.inductiveautomation.ignition.client.launch.util.LaunchSysProp<T>

Direct Known Subclasses:

LaunchSysProp.BooleanLaunchSysProp, LaunchSysProp.IntLaunchSysProp, LaunchSysProp.LaunchSysPropWithJvm, LaunchSysProp.LongLaunchSysProp, LaunchSysProp.SequenceLaunchSysProp, LaunchSysProp.StringLaunchSysProp

public abstract class LaunchSysProp<T>
extends Object

A System Property reference which has its value set at instantiation. This value is typically supplied via the System.getProperty(String) function, taking into account any legacyKey values as backup

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LaunchSysProp.BooleanLaunchSysProp	Analogous to LaunchSysProp.StringLaunchSysProp, but for Booleans.
static class	LaunchSysProp.IntLaunchSysProp	Analogous to LaunchSysProp.StringLaunchSysProp, but for Integers.
static class	LaunchSysProp.LaunchSysPropWithJvm	A system prop which has keys and legacy keys, but also has a companion "jvm" property which should be set along with it.
static class	LaunchSysProp.LongLaunchSysProp	Analogous to LaunchSysProp.StringLaunchSysProp, but for Longs.
static class	LaunchSysProp.SequenceLaunchSysProp	A collection of system props which expect to have a 'list' of system properties which are in the form of {key}.{index}.
static class	LaunchSysProp.StringLaunchSysProp	The most standard form of a system property, whose value is simply a (nullable) String type.

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	key
protected final String	legacyKey
protected final T	value

Method Summary

Modifier and Type	Method	Description
String	key()
Set<String>	toDProps()	Returns a set of CLI arguments in the form of -D${key}=${value}, unless the value is null, then an empty Set is returned
Set<String>	toDPropsWith(T value)	Returns a set of CLI arguments in the form of -D${key}=${value}, unless the value is null, then an empty Set is returned.
T	value()	Returns the value assigned at instantiation.
T	valueOr(T defaultValue)	Returns the value assigned at instantiation or the defaultValue supplied

Methods inherited from class java.lang.Object

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

Field Details

key

protected final String key

value

protected final T value

legacyKey

protected final String legacyKey

Method Details

key

@Nonnull
public String key()

value

@Nullable
public T value()

Returns the value assigned at instantiation. May be null

valueOr

@Nonnull
public T valueOr(@Nonnull
 T defaultValue)

Returns the value assigned at instantiation or the defaultValue supplied

toDProps

@Nonnull
public Set<String> toDProps()

Returns a set of CLI arguments in the form of -D${key}=${value}, unless the value is null, then an empty Set is returned

toDPropsWith

@Nonnull
public Set<String> toDPropsWith(@Nullable
 T value)

Returns a set of CLI arguments in the form of -D${key}=${value}, unless the value is null, then an empty Set is returned. The value which is provided is the value which is always returned. This is a convenience method for returning the correct CLI arguments, but where a new value is required, like on retargets etc