Package com.inductiveautomation.ignition.common.jsonschema

Interface JsonValidator

All Known Subinterfaces:
MetaValidator
All Known Implementing Classes:
AdditionalPropertiesValidator, AllOfValidator, AnyOfValidator, BaseJsonValidator, ConstValidator, ContainsValidator, DependenciesValidator, DynamicSuggestionsValidator, EnumValidator, ExtensionValidator, FormatValidator, ItemsValidator, JsonSchema, MaximumValidator, MaxItemsValidator, MaxLengthValidator, MaxPropertiesValidator, MinimumValidator, MinItemsValidator, MinLengthValidator, MinPropertiesValidator, MultipleOfValidator, NotValidator, OneOfValidator, PatternPropertiesValidator, PatternValidator, PropertiesValidator, PropertyNamesValidator, RefValidator, RequiredValidator, SuggestionsValidator, TypeValidator, UniqueItemsValidator, VisibleWhenValidator
public interface JsonValidator
Standard json validator interface, implemented by all validators and JsonSchema.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AT_ROOT
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Set<ValidationMessage>
    validate(com.inductiveautomation.ignition.common.gson.JsonElement rootNode)
    Validate the given root JsonElement, starting at the root of the data path.
    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.

  • Field Details

  • Method Details

    • validate

      Set<ValidationMessage> validate(com.inductiveautomation.ignition.common.gson.JsonElement rootNode)
      Validate the given root JsonElement, starting at the root of the data path.
      Parameters:
      rootNode - JsonElement
      Returns:
      A list of ValidationMessage if there is any validation error, or an empty list if there is no error.

    • validate

      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.
      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.