Package com.inductiveautomation.ignition.common

Class SystemProp<T>

java.lang.Object

com.inductiveautomation.ignition.common.SystemProp<T>

public abstract class SystemProp<T>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final T	defaultValue
final String	descriptionKey
final String	key

Constructor Summary

Constructors

Constructor	Description
SystemProp(String key, @Nullable String migrationKey, String descriptionKey, Class<T> clazz, T defaultValue)

Method Summary

Modifier and Type	Method	Description
static SystemProp<Boolean>	forBoolean(String key, @Nullable String migrationKey, String descriptionKey)
static SystemProp<Boolean>	forBoolean(String key, @Nullable String migrationKey, String descriptionKey, @Nullable Boolean defaultValue)
static SystemProp<Boolean>	forBoolean(String key, String descriptionKey)
static SystemProp<Double>	forDouble(String key, @Nullable String migrationKey, String descriptionKey)
static SystemProp<Double>	forDouble(String key, @Nullable String migrationKey, String descriptionKey, @Nullable Double defaultValue)
static SystemProp<Double>	forDouble(String key, String descriptionKey)
static SystemProp<Float>	forFloat(String key, @Nullable String migrationKey, String descriptionKey)
static SystemProp<Float>	forFloat(String key, @Nullable String migrationKey, String descriptionKey, @Nullable Float defaultValue)
static SystemProp<Float>	forFloat(String key, String descriptionKey)
static SystemProp<Integer>	forInteger(String key, @Nullable String migrationKey, String descriptionKey)
static SystemProp<Integer>	forInteger(String key, @Nullable String migrationKey, String descriptionKey, @Nullable Integer defaultValue)
static SystemProp<Integer>	forInteger(String key, String descriptionKey)
static SystemProp<Long>	forLong(String key, @Nullable String migrationKey, String descriptionKey)
static SystemProp<Long>	forLong(String key, @Nullable String migrationKey, String descriptionKey, @Nullable Long defaultValue)
static SystemProp<Long>	forLong(String key, String descriptionKey)
static SystemProp<String>	forString(String key, @Nullable String migrationKey, String descriptionKey)
static SystemProp<String>	forString(String key, @Nullable String migrationKey, String descriptionKey, @Nullable String defaultValue)
static SystemProp<String>	forString(String key, String descriptionKey)
String	getKey()
abstract T	getValue()	Safe call.
T	getValueOrNull()	Unsafe call.

Methods inherited from class java.lang.Object

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

Field Details

key

public final String key

descriptionKey

public final String descriptionKey

defaultValue

@Nullable
public final T defaultValue

Constructor Details

SystemProp

public SystemProp(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey,
 Class<T> clazz,
 @Nullable
 T defaultValue)

Method Details

getKey

public String getKey()

getValue

@NotNull
public abstract T getValue()

Safe call. Retrieves the property value if not null, otherwise the default value. If both are null, the following fallback values are returned for known types:

• String - an empty string
• Boolean - false
• Integer, Long, Double, Float - 0

Numeric types will return the fallback value rather than throw a NumberFormatException

getValueOrNull

@Nullable
public T getValueOrNull()

Unsafe call. The retrieval order for nullable values is as follows:

• using the primary key
• fall back to the migration key
• fall back to the default value if non-null
• and finally to null.

This method may throw a NumberFormatException if the runtime cannot be parsed.

forString

public static SystemProp<String> forString(String key,
 String descriptionKey)

forString

public static SystemProp<String> forString(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey)

forString

public static SystemProp<String> forString(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey,
 @Nullable
 @Nullable String defaultValue)

forBoolean

public static SystemProp<Boolean> forBoolean(String key,
 String descriptionKey)

forBoolean

public static SystemProp<Boolean> forBoolean(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey)

forBoolean

public static SystemProp<Boolean> forBoolean(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey,
 @Nullable
 @Nullable Boolean defaultValue)

forInteger

public static SystemProp<Integer> forInteger(String key,
 String descriptionKey)

forInteger

public static SystemProp<Integer> forInteger(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey)

forInteger

public static SystemProp<Integer> forInteger(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey,
 @Nullable
 @Nullable Integer defaultValue)

forLong

public static SystemProp<Long> forLong(String key,
 String descriptionKey)

forLong

public static SystemProp<Long> forLong(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey)

forLong

public static SystemProp<Long> forLong(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey,
 @Nullable
 @Nullable Long defaultValue)

forFloat

public static SystemProp<Float> forFloat(String key,
 String descriptionKey)

forFloat

public static SystemProp<Float> forFloat(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey)

forFloat

public static SystemProp<Float> forFloat(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey,
 @Nullable
 @Nullable Float defaultValue)

forDouble

public static SystemProp<Double> forDouble(String key,
 String descriptionKey)

forDouble

public static SystemProp<Double> forDouble(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey)

forDouble

public static SystemProp<Double> forDouble(String key,
 @Nullable
 @Nullable String migrationKey,
 String descriptionKey,
 @Nullable
 @Nullable Double defaultValue)