Package com.inductiveautomation.ignition.common.jsonschema

Class PropertiesValidator

java.lang.Object

com.inductiveautomation.ignition.common.jsonschema.BaseJsonValidator

com.inductiveautomation.ignition.common.jsonschema.PropertiesValidator

All Implemented Interfaces:

JsonValidator

public class PropertiesValidator
extends BaseJsonValidator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY

Fields inherited from interface com.inductiveautomation.ignition.common.jsonschema.JsonValidator

AT_ROOT

Constructor Summary

Constructors

Constructor	Description
PropertiesValidator(String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema)

Method Summary

Modifier and Type	Method	Description
com.inductiveautomation.ignition.common.gson.JsonObject	deriveDefaultObject()
com.inductiveautomation.ignition.common.gson.JsonObject	deriveDefaultObject(boolean injectExampleIfPresent)	Returns a derived JsonObject which may include values declared under the 'example' key.
protected Optional<JsonSchema>	findSchemaForProperty(String propertyKey)
List<String>	getPropertyNames()
Set<ValidationMessage>	validate(com.inductiveautomation.ignition.common.gson.JsonElement node, com.inductiveautomation.ignition.common.gson.JsonElement rootNode, String at)	Validate the given JsonElement, the given node is the child node of the root node at given data path.

Methods inherited from class com.inductiveautomation.ignition.common.jsonschema.BaseJsonValidator

asInt, buildValidationMessage, debug, equals, getParentSchema, getSchemaNode, getSchemaPath, getSubSchema, getValidatorType, greaterThan, hasSubSchema, lessThan, obtainSubSchemaNode, parseErrorCode, useRefCache, validate

Methods inherited from class java.lang.Object

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

Field Details

PROPERTY

public static final String PROPERTY

See Also:

• Constant Field Values

Constructor Details

PropertiesValidator

public PropertiesValidator(String schemaPath,
 com.inductiveautomation.ignition.common.gson.JsonElement schemaNode,
 JsonSchema parentSchema)

Method Details

findSchemaForProperty

protected Optional<JsonSchema> findSchemaForProperty(String propertyKey)

validate

public Set<ValidationMessage> validate(com.inductiveautomation.ignition.common.gson.JsonElement node,
 com.inductiveautomation.ignition.common.gson.JsonElement rootNode,
 String at)

Description copied from interface: JsonValidator

Validate the given JsonElement, the given node is the child node of the root node at given data path.

Parameters:

node - JsonElement

rootNode - JsonElement

at - String

Returns:

A list of ValidationMessage if there is any validation error, or an empty list if there is no error.

getPropertyNames

public List<String> getPropertyNames()

deriveDefaultObject

public com.inductiveautomation.ignition.common.gson.JsonObject deriveDefaultObject(boolean injectExampleIfPresent)

Returns a derived JsonObject which may include values declared under the 'example' key.

Parameters:

injectExampleIfPresent - if true, checks for example values and adds them as the default.

deriveDefaultObject

public com.inductiveautomation.ignition.common.gson.JsonObject deriveDefaultObject()