Class PropertiesValidator
java.lang.Object
com.inductiveautomation.ignition.common.jsonschema.BaseJsonValidator
com.inductiveautomation.ignition.common.jsonschema.PropertiesValidator
- All Implemented Interfaces:
JsonValidator
-
Field Summary
FieldsFields inherited from interface JsonValidator
AT_ROOT -
Constructor Summary
ConstructorsConstructorDescriptionPropertiesValidator(String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema) -
Method Summary
Modifier and TypeMethodDescriptioncom.inductiveautomation.ignition.common.gson.JsonObjectcom.inductiveautomation.ignition.common.gson.JsonObjectderiveDefaultObject(boolean injectExampleIfPresent) Returns a derived JsonObject which may include values declared under the 'example' key.protected Optional<JsonSchema> findSchemaForProperty(String propertyKey) 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 BaseJsonValidator
asInt, buildValidationMessage, debug, equals, getParentSchema, getSchemaNode, getSchemaPath, getSubSchema, getValidatorType, greaterThan, hasSubSchema, lessThan, obtainSubSchemaNode, parseErrorCode, useRefCache, validate
-
Field Details
-
PROPERTY
- See Also:
-
-
Constructor Details
-
PropertiesValidator
public PropertiesValidator(String schemaPath, com.inductiveautomation.ignition.common.gson.JsonElement schemaNode, JsonSchema parentSchema)
-
-
Method Details
-
findSchemaForProperty
-
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:JsonValidatorValidate 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
-
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()
-