Package com.networknt.oas.model

Interface Schema

  • All Superinterfaces:
    com.networknt.jsonoverlay.IJsonOverlay<Schema>, com.networknt.jsonoverlay.IModelPart<OpenApi3,​Schema>
    All Known Implementing Classes:
    SchemaImpl
    public interface Schema
extends com.networknt.jsonoverlay.IJsonOverlay<Schema>, com.networknt.jsonoverlay.IModelPart<OpenApi3,​Schema>

    • Method Detail

      • setTitle

        void setTitle​(String title)

      • getMultipleOf

        Number getMultipleOf()

      • setMultipleOf

        void setMultipleOf​(Number multipleOf)

      • getMaximum

        Number getMaximum()

      • setMaximum

        void setMaximum​(Number maximum)

      • getExclusiveMaximum

        Boolean getExclusiveMaximum()

      • isExclusiveMaximum

        boolean isExclusiveMaximum()

      • setExclusiveMaximum

        void setExclusiveMaximum​(Boolean exclusiveMaximum)

      • getMinimum

        Number getMinimum()

      • setMinimum

        void setMinimum​(Number minimum)

      • getExclusiveMinimum

        Boolean getExclusiveMinimum()

      • isExclusiveMinimum

        boolean isExclusiveMinimum()

      • setExclusiveMinimum

        void setExclusiveMinimum​(Boolean exclusiveMinimum)

      • getMaxLength

        Integer getMaxLength()

      • setMaxLength

        void setMaxLength​(Integer maxLength)

      • getMinLength

        Integer getMinLength()

      • setMinLength

        void setMinLength​(Integer minLength)

      • getPattern

        String getPattern()

      • setPattern

        void setPattern​(String pattern)

      • getMaxItems

        Integer getMaxItems()

      • setMaxItems

        void setMaxItems​(Integer maxItems)

      • getMinItems

        Integer getMinItems()

      • setMinItems

        void setMinItems​(Integer minItems)

      • getUniqueItems

        Boolean getUniqueItems()

      • isUniqueItems

        boolean isUniqueItems()

      • setUniqueItems

        void setUniqueItems​(Boolean uniqueItems)

      • getMaxProperties

        Integer getMaxProperties()

      • setMaxProperties

        void setMaxProperties​(Integer maxProperties)

      • getMinProperties

        Integer getMinProperties()

      • setMinProperties

        void setMinProperties​(Integer minProperties)

      • getRequiredFields

        List<String> getRequiredFields()

      • getRequiredFields

        List<String> getRequiredFields​(boolean elaborate)

      • hasRequiredFields

        boolean hasRequiredFields()

      • getRequiredField

        String getRequiredField​(int index)

      • setRequiredFields

        void setRequiredFields​(List<String> requiredFields)

      • setRequiredField

        void setRequiredField​(int index,
                      String requiredField)

      • addRequiredField

        void addRequiredField​(String requiredField)

      • insertRequiredField

        void insertRequiredField​(int index,
                         String requiredField)

      • removeRequiredField

        void removeRequiredField​(int index)

      • getEnums

        List<Object> getEnums​(boolean elaborate)

      • hasEnums

        boolean hasEnums()

      • getEnum

        Object getEnum​(int index)

      • setEnum

        void setEnum​(int index,
             Object enumValue)

      • addEnum

        void addEnum​(Object enumValue)

      • insertEnum

        void insertEnum​(int index,
                Object enumValue)

      • removeEnum

        void removeEnum​(int index)

      • setType

        void setType​(String type)

      • getAllOfSchemas

        List<Schema> getAllOfSchemas​(boolean elaborate)

      • hasAllOfSchemas

        boolean hasAllOfSchemas()

      • getAllOfSchema

        Schema getAllOfSchema​(int index)

      • setAllOfSchemas

        void setAllOfSchemas​(List<Schema> allOfSchemas)

      • setAllOfSchema

        void setAllOfSchema​(int index,
                    Schema allOfSchema)

      • addAllOfSchema

        void addAllOfSchema​(Schema allOfSchema)

      • insertAllOfSchema

        void insertAllOfSchema​(int index,
                       Schema allOfSchema)

      • removeAllOfSchema

        void removeAllOfSchema​(int index)

      • getOneOfSchemas

        List<Schema> getOneOfSchemas​(boolean elaborate)

      • hasOneOfSchemas

        boolean hasOneOfSchemas()

      • getOneOfSchema

        Schema getOneOfSchema​(int index)

      • setOneOfSchemas

        void setOneOfSchemas​(List<Schema> oneOfSchemas)

      • setOneOfSchema

        void setOneOfSchema​(int index,
                    Schema oneOfSchema)

      • addOneOfSchema

        void addOneOfSchema​(Schema oneOfSchema)

      • insertOneOfSchema

        void insertOneOfSchema​(int index,
                       Schema oneOfSchema)

      • removeOneOfSchema

        void removeOneOfSchema​(int index)

      • getAnyOfSchemas

        List<Schema> getAnyOfSchemas​(boolean elaborate)

      • hasAnyOfSchemas

        boolean hasAnyOfSchemas()

      • getAnyOfSchema

        Schema getAnyOfSchema​(int index)

      • setAnyOfSchemas

        void setAnyOfSchemas​(List<Schema> anyOfSchemas)

      • setAnyOfSchema

        void setAnyOfSchema​(int index,
                    Schema anyOfSchema)

      • addAnyOfSchema

        void addAnyOfSchema​(Schema anyOfSchema)

      • insertAnyOfSchema

        void insertAnyOfSchema​(int index,
                       Schema anyOfSchema)

      • removeAnyOfSchema

        void removeAnyOfSchema​(int index)

      • getNotSchema

        Schema getNotSchema()

      • getNotSchema

        Schema getNotSchema​(boolean elaborate)

      • setNotSchema

        void setNotSchema​(Schema notSchema)

      • getItemsSchema

        Schema getItemsSchema()

      • getItemsSchema

        Schema getItemsSchema​(boolean elaborate)

      • setItemsSchema

        void setItemsSchema​(Schema itemsSchema)

      • getProperties

        Map<String,​Schema> getProperties​(boolean elaborate)

      • hasProperties

        boolean hasProperties()

      • hasProperty

        boolean hasProperty​(String name)

      • setProperty

        void setProperty​(String name,
                 Schema property)

      • removeProperty

        void removeProperty​(String name)

      • getAdditionalPropertiesSchema

        Schema getAdditionalPropertiesSchema()

      • getAdditionalPropertiesSchema

        Schema getAdditionalPropertiesSchema​(boolean elaborate)

      • setAdditionalPropertiesSchema

        void setAdditionalPropertiesSchema​(Schema additionalPropertiesSchema)

      • getAdditionalProperties

        Boolean getAdditionalProperties()

      • isAdditionalProperties

        boolean isAdditionalProperties()

      • setAdditionalProperties

        void setAdditionalProperties​(Boolean additionalProperties)

      • getDescription

        String getDescription()

      • setDescription

        void setDescription​(String description)

      • getFormat

        String getFormat()

      • setFormat

        void setFormat​(String format)

      • getDefault

        Object getDefault()

      • setDefault

        void setDefault​(Object defaultValue)

      • getNullable

        Boolean getNullable()

      • isNullable

        boolean isNullable()

      • setNullable

        void setNullable​(Boolean nullable)

      • getDiscriminator

        Discriminator getDiscriminator​(boolean elaborate)

      • setDiscriminator

        void setDiscriminator​(Discriminator discriminator)

      • getReadOnly

        Boolean getReadOnly()

      • isReadOnly

        boolean isReadOnly()

      • setReadOnly

        void setReadOnly​(Boolean readOnly)

      • getWriteOnly

        Boolean getWriteOnly()

      • isWriteOnly

        boolean isWriteOnly()

      • setWriteOnly

        void setWriteOnly​(Boolean writeOnly)

      • getXml

        Xml getXml()

      • getXml

        Xml getXml​(boolean elaborate)

      • setXml

        void setXml​(Xml xml)

      • getExternalDocs

        ExternalDocs getExternalDocs​(boolean elaborate)

      • setExternalDocs

        void setExternalDocs​(ExternalDocs externalDocs)

      • getExample

        Object getExample()

      • setExample

        void setExample​(Object example)

      • getDeprecated

        Boolean getDeprecated()

      • isDeprecated

        boolean isDeprecated()

      • setDeprecated

        void setDeprecated​(Boolean deprecated)

      • getExtensions

        Map<String,​Object> getExtensions​(boolean elaborate)

      • hasExtensions

        boolean hasExtensions()

      • hasExtension

        boolean hasExtension​(String name)

      • setExtension

        void setExtension​(String name,
                  Object extension)

      • removeExtension

        void removeExtension​(String name)