Package org.forgerock.api.jackson

Class CrestArraySchema

  • All Implemented Interfaces:
    WithExampleSchema<List<Object>>
    public class CrestArraySchema
extends com.fasterxml.jackson.module.jsonSchema.types.ArraySchema
implements WithExampleSchema<List<Object>>
    An extension to the Jackson ArraySchema that includes the custom CREST JSON Schema attributes.

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.fasterxml.jackson.module.jsonSchema.types.ArraySchema

        com.fasterxml.jackson.module.jsonSchema.types.ArraySchema.AdditionalItems, com.fasterxml.jackson.module.jsonSchema.types.ArraySchema.ArrayItems, com.fasterxml.jackson.module.jsonSchema.types.ArraySchema.Items, com.fasterxml.jackson.module.jsonSchema.types.ArraySchema.ItemsDeserializer, com.fasterxml.jackson.module.jsonSchema.types.ArraySchema.NoAdditionalItems, com.fasterxml.jackson.module.jsonSchema.types.ArraySchema.SchemaAdditionalItems, com.fasterxml.jackson.module.jsonSchema.types.ArraySchema.SingleItems

    • Field Summary

      • Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.ArraySchema

        additionalItems, items, maxItems, minItems, uniqueItems

      • Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.ContainerTypeSchema

        enums, oneOf

      • Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema

        defaultdefault, links, pathStart, title

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Boolean getErrorOnWritePolicyFailure()  
      List<Object> getExample()
      Gets example JSON Schema field.
      Integer getPropertyOrder()  
      ReadPolicy getReadPolicy()  
      Boolean getReturnOnDemand()  
      WritePolicy getWritePolicy()  
      void setErrorOnWritePolicyFailure​(Boolean errorOnWritePolicyFailure)  
      void setExample​(String example)
      Sets example JSON Schema field.
      void setPropertyOrder​(Integer order)  
      void setReadPolicy​(ReadPolicy readPolicy)  
      void setReturnOnDemand​(Boolean returnOnDemand)  
      void setWritePolicy​(WritePolicy policy)  
      void validate​(JsonValue object)  

      • Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.ArraySchema

        _equals, asArraySchema, equals, getAdditionalItems, getItems, getMaxItems, getMinItems, getType, getUniqueItems, isArraySchema, setAdditionalItems, setItems, setItemsSchema, setMaxItems, setMinItems, setUniqueItems

      • Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.ContainerTypeSchema

        _equals, asContainerSchema, asContainerTypeSchema, getEnums, getOneOf, isContainerTypeSchema, setEnums, setOneOf

      • Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema

        _equals, asSimpleTypeSchema, getDefault, getLinks, getPathStart, getTitle, isSimpleTypeSchema, setDefault, setLinks, setPathStart, setTitle

      • Methods inherited from class com.fasterxml.jackson.module.jsonSchema.JsonSchema

        _equals, arraysEqual, asAnySchema, asBooleanSchema, asIntegerSchema, asNullSchema, asNumberSchema, asObjectSchema, asStringSchema, asUnionTypeSchema, asValueSchemaSchema, asValueTypeSchema, enrichWithBeanProperty, equals, get$ref, get$schema, getDescription, getDisallow, getExtends, getId, getReadonly, getRequired, isAnySchema, isBooleanSchema, isIntegerSchema, isNullSchema, isNumberSchema, isObjectSchema, isStringSchema, isUnionTypeSchema, isValueTypeSchema, minimalForFormat, set$ref, set$schema, setDescription, setDisallow, setExtends, setId, setReadonly, setRequired

    • Constructor Detail

      • CrestArraySchema

        public CrestArraySchema()

    • Method Detail

      • setWritePolicy

        public void setWritePolicy​(WritePolicy policy)

      • getReadPolicy

        public ReadPolicy getReadPolicy()

      • setReadPolicy

        public void setReadPolicy​(ReadPolicy readPolicy)

      • getErrorOnWritePolicyFailure

        public Boolean getErrorOnWritePolicyFailure()

      • setErrorOnWritePolicyFailure

        public void setErrorOnWritePolicyFailure​(Boolean errorOnWritePolicyFailure)

      • getReturnOnDemand

        public Boolean getReturnOnDemand()

      • setReturnOnDemand

        public void setReturnOnDemand​(Boolean returnOnDemand)

      • getPropertyOrder

        public Integer getPropertyOrder()

      • setPropertyOrder

        public void setPropertyOrder​(Integer order)

      • validate

        public void validate​(JsonValue object)
              throws javax.validation.ValidationException
        Throws:
        javax.validation.ValidationException