Class ItemsValidator
- java.lang.Object
-
- com.inductiveautomation.ignition.common.jsonschema.BaseJsonValidator
-
- com.inductiveautomation.ignition.common.jsonschema.ItemsValidator
-
- All Implemented Interfaces:
JsonValidator
public class ItemsValidator extends BaseJsonValidator
A validator (keyed offitems
) that either defines a schema for all items in an arbitrarily long sequence, or a validator with a fixed set of schemas - both the contents and the number of those child schemas must match to be valid.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PROPERTY
-
Fields inherited from interface com.inductiveautomation.ignition.common.jsonschema.JsonValidator
AT_ROOT
-
-
Constructor Summary
Constructors Constructor Description ItemsValidator(java.lang.String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description com.inductiveautomation.ignition.common.gson.JsonArray
deriveDefaultArray()
com.inductiveautomation.ignition.common.gson.JsonArray
deriveDefaultArray(boolean includeExample)
java.util.Optional<JsonSchema>
findSchemaForIndex(int index)
java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonElement>
getDefaultItem()
java.util.List<JsonSchema>
getSchemas()
boolean
isBoundedSchema()
java.util.Set<ValidationMessage>
validate(com.inductiveautomation.ignition.common.gson.JsonElement node, com.inductiveautomation.ignition.common.gson.JsonElement rootNode, java.lang.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
-
-
-
-
Field Detail
-
PROPERTY
public static final java.lang.String PROPERTY
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ItemsValidator
public ItemsValidator(java.lang.String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema)
-
-
Method Detail
-
findSchemaForIndex
public java.util.Optional<JsonSchema> findSchemaForIndex(int index)
-
getSchemas
public java.util.List<JsonSchema> getSchemas()
- Returns:
- a sequence of schemas underneath this validator.
-
isBoundedSchema
public boolean isBoundedSchema()
- Returns:
- true if this validator is constrained to a fixed sequence of items, or false if it applies a schema to all items in an arbitrary sequence.
-
validate
public java.util.Set<ValidationMessage> validate(com.inductiveautomation.ignition.common.gson.JsonElement node, com.inductiveautomation.ignition.common.gson.JsonElement rootNode, java.lang.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
- JsonElementrootNode
- JsonElementat
- String- Returns:
- A list of ValidationMessage if there is any validation error, or an empty list if there is no error.
-
deriveDefaultArray
public com.inductiveautomation.ignition.common.gson.JsonArray deriveDefaultArray()
-
deriveDefaultArray
public com.inductiveautomation.ignition.common.gson.JsonArray deriveDefaultArray(boolean includeExample)
-
getDefaultItem
public java.util.Optional<com.inductiveautomation.ignition.common.gson.JsonElement> getDefaultItem()
-
-