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 java.lang.String
PROPERTY
-
Fields inherited from interface com.inductiveautomation.ignition.common.jsonschema.JsonValidator
AT_ROOT
-
-
Constructor Summary
Constructors Constructor Description PropertiesValidator(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.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 java.util.Optional<JsonSchema>
findSchemaForProperty(java.lang.String propertyKey)
java.util.List<java.lang.String>
getPropertyNames()
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
-
PropertiesValidator
public PropertiesValidator(java.lang.String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema)
-
-
Method Detail
-
findSchemaForProperty
protected java.util.Optional<JsonSchema> findSchemaForProperty(java.lang.String propertyKey)
-
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.
-
getPropertyNames
public java.util.List<java.lang.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()
-
-