Package com.inductiveautomation.perspective.common

Class ConfigCondition

java.lang.Object

com.inductiveautomation.perspective.common.ConfigCondition

public class ConfigCondition
extends Object

Convenience class for ensuring that a json object structure has expected members in it.

Method Summary

Modifier and Type	Method	Description
static ConfigCondition	ofObject(com.inductiveautomation.ignition.common.gson.JsonElement object)
ConfigCondition	optional(String name, Predicate<com.inductiveautomation.ignition.common.gson.JsonElement> predicate, Function<com.inductiveautomation.ignition.common.gson.JsonElement,String> errorMessage)	General purpose optional-check.
ConfigCondition	optionalArray(String name)	Checks to see if a member with the given name exists.
ConfigCondition	optionalBoolean(String name)	Checks to see if a member with the given name exists.
<E extends Enum> ConfigCondition	optionalEnum(String name, Class<E> enumClass)	Case-sensitive enum comparison
<E extends Enum> ConfigCondition	optionalEnum(String name, Class<E> enumClass, boolean ignoreCase)
ConfigCondition	optionalObject(String name)	Checks to see if a member with the given name exists.
ConfigCondition	optionalOneOf(String name, @NonNull JsonType... types)	Checks to see if a member with the given name exists.
ConfigCondition	optionalString(String name)	Checks to see if a member with the given name exists.
ConfigCondition	requireNonBlankString(String name)	Requires that the property at the given path is a string that is not blank.
ConfigCondition	requireObject(String name)	Requires that the property at the given path is an object.
ConfigCondition	requireOneOf(String name, @NonNull JsonType... types)	Requires that the property at the given path is one of the provided JsonTypes.
ConfigCondition	requireString(String name)	Requires that the property at the given path is a string.

Methods inherited from class java.lang.Object

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

Method Details

ofObject

public static ConfigCondition ofObject(com.inductiveautomation.ignition.common.gson.JsonElement object)
                                throws ConfigurationException

Throws:

ConfigurationException

optionalOneOf

public ConfigCondition optionalOneOf(String name,
 @NonNull JsonType... types)
                              throws ConfigurationException

Checks to see if a member with the given name exists. If it does, ensures that it is one of the provided JsonTypes

Throws:

ConfigurationException

requireOneOf

public ConfigCondition requireOneOf(String name,
 @NonNull JsonType... types)
                             throws ConfigurationException

Requires that the property at the given path is one of the provided JsonTypes. Does not accept null, missing, or otherwise mis-typed.

Throws:

ConfigurationException

requireObject

public ConfigCondition requireObject(String name)
                              throws ConfigurationException

Requires that the property at the given path is an object. Does not accept null, missing, or otherwise mis-typed.

Throws:

ConfigurationException

requireString

public ConfigCondition requireString(String name)
                              throws ConfigurationException

Requires that the property at the given path is a string. Accepts empty string, but not null, missing, or otherwise mis-typed.

Throws:

ConfigurationException

requireNonBlankString

public ConfigCondition requireNonBlankString(String name)
                                      throws ConfigurationException

Requires that the property at the given path is a string that is not blank. Accepts empty string, but not null, missing, or otherwis mis-typed.

Throws:

ConfigurationException

See Also:

• StringUtils.isNotBlank(CharSequence)

optionalEnum

public <E extends Enum> ConfigCondition optionalEnum(String name,
 Class<E> enumClass)
                                              throws ConfigurationException

Case-sensitive enum comparison

Throws:

ConfigurationException

See Also:

• optionalEnum(String, Class, boolean)

optionalEnum

public <E extends Enum> ConfigCondition optionalEnum(String name,
 Class<E> enumClass,
 boolean ignoreCase)
                                              throws ConfigurationException

Throws:

ConfigurationException

optionalObject

public ConfigCondition optionalObject(String name)
                               throws ConfigurationException

Checks to see if a member with the given name exists. If it does, ensures that it is an object.

Throws:

ConfigurationException

optionalArray

public ConfigCondition optionalArray(String name)
                              throws ConfigurationException

Checks to see if a member with the given name exists. If it does, ensures that it is an array.

Throws:

ConfigurationException

optionalBoolean

public ConfigCondition optionalBoolean(String name)
                                throws ConfigurationException

Checks to see if a member with the given name exists. If it does, ensures that it is a boolean.

Throws:

ConfigurationException

optionalString

public ConfigCondition optionalString(String name)
                               throws ConfigurationException

Checks to see if a member with the given name exists. If it does, ensures that it is a string.

Throws:

ConfigurationException

optional

public ConfigCondition optional(String name,
 Predicate<com.inductiveautomation.ignition.common.gson.JsonElement> predicate,
 Function<com.inductiveautomation.ignition.common.gson.JsonElement,String> errorMessage)
                         throws ConfigurationException

General purpose optional-check. If the object at the given name is missing, this is OK. But if the object is present, it must pass the predicate.

Throws:

ConfigurationException