Class PropertiesValidator

    • 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 - 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 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()