Package org.forgerock.api.jackson

Class CrestBooleanSchema

java.lang.Object
com.fasterxml.jackson.module.jsonSchema.JsonSchema
com.fasterxml.jackson.module.jsonSchema.types.SimpleTypeSchema
com.fasterxml.jackson.module.jsonSchema.types.ValueTypeSchema
com.fasterxml.jackson.module.jsonSchema.types.BooleanSchema
org.forgerock.api.jackson.CrestBooleanSchema
All Implemented Interfaces:
WithExampleSchema<Boolean>
public class CrestBooleanSchema extends com.fasterxml.jackson.module.jsonSchema.types.BooleanSchema implements WithExampleSchema<Boolean>
An extension to the Jackson BooleanSchema that includes the custom CREST JSON Schema attributes.

  • Field Summary

    Fields inherited from class com.fasterxml.jackson.module.jsonSchema.types.ValueTypeSchema

    enums, format

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

    defaultdefault, links, pathStart, title

  • Constructor Summary

    Constructors
    Constructor
    Description
    CrestBooleanSchema()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getErrorOnWritePolicyFailure()
     
    Boolean
    getExample()
    Gets example JSON Schema field.
    Integer
    getPropertyOrder()
     
    Boolean
    getReadonly()
    Gets read-only property.
    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.BooleanSchema

    _equals, asBooleanSchema, equals, getType, isBooleanSchema

    Methods inherited from class com.fasterxml.jackson.module.jsonSchema.types.ValueTypeSchema

    _equals, asValueSchemaSchema, asValueTypeSchema, getEnums, getFormat, isValueTypeSchema, setEnums, setFormat

    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, asArraySchema, asContainerSchema, asContainerTypeSchema, asIntegerSchema, asNullSchema, asNumberSchema, asObjectSchema, asStringSchema, asUnionTypeSchema, enrichWithBeanProperty, equals, get$ref, get$schema, getDescription, getDisallow, getExtends, getId, getRequired, isAnySchema, isArraySchema, isContainerTypeSchema, isIntegerSchema, isNullSchema, isNumberSchema, isObjectSchema, isStringSchema, isUnionTypeSchema, minimalForFormat, set$ref, set$schema, setDescription, setDisallow, setExtends, setId, setReadonly, setRequired

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • CrestBooleanSchema

      public CrestBooleanSchema()

  • Method Details

    • getWritePolicy

      public WritePolicy getWritePolicy()

    • 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

    • getReadonly

      public Boolean getReadonly()
      Gets read-only property. This method overrides the superclass' definition of "readOnly" being all lower-case, via the JsonProperty annotation.
      Overrides:
      getReadonly in class com.fasterxml.jackson.module.jsonSchema.JsonSchema
      Returns:
      true if property is read-only, otherwise false or null

    • getExample

      public Boolean getExample()
      Description copied from interface: WithExampleSchema
      Gets example JSON Schema field.
      Specified by:
      getExample in interface WithExampleSchema<Boolean>
      Returns:
      The example value, or null if not defined.

    • setExample

      public void setExample(String example)
      Description copied from interface: WithExampleSchema
      Sets example JSON Schema field.
      Specified by:
      setExample in interface WithExampleSchema<Boolean>
      Parameters:
      example - The example value.