java.lang.Object
- io.openapiparser.Properties
- - io.openapiparser.model.v30.Schema

All Implemented Interfaces:

Extensions, Reference
```
public class Schema
extends Properties
implements Reference, Extensions
```
the Schema object.
See specification: 4.7.24 Schema Object JSON Schema JSON Schema Validation

Field Summary
- Fields inherited from class io.openapiparser.Properties
  bucket, context

Constructor Summary

Constructors
Constructor Description

Schema(Context context, io.openapiprocessor.jsonschema.schema.Bucket bucket)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`@Nullable java.lang.Object`	`getAdditionalProperties()`	JSON Schema Validation: validation keyword.
`java.util.Collection<Schema>`	`getAllOf()`	JSON Schema Validation: validation keyword
`java.util.Collection<Schema>`	`getAnyOf()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Object`	`getDefault()`	JSON Schema Validation: metadata keyword
`java.lang.Boolean`	`getDeprecated()`	OpenAPI Schema
`@Nullable java.lang.String`	`getDescription()`	JSON Schema Validation: metadata keyword.
`@Nullable Discriminator`	`getDiscriminator()`	OpenAPI Schema
`@Nullable java.util.Collection<?>`	`getEnum()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Object`	`getExample()`	OpenAPI Schema
`java.lang.Boolean`	`getExclusiveMaximum()`	JSON Schema Validation: validation keyword
`java.lang.Boolean`	`getExclusiveMinimum()`	JSON Schema Validation: validation keyword
`java.util.Map<java.lang.String,java.lang.Object>`	`getExtensions()`	map of all extension properties.
`@Nullable ExternalDocumentation`	`getExternalDocs()`	OpenAPI Schema
`@Nullable java.lang.String`	`getFormat()`	JSON Schema Validation: semantic validation keyword
`@Nullable Schema`	`getItems()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Number`	`getMaximum()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Integer`	`getMaxItems()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Number`	`getMaxLength()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Integer`	`getMaxProperties()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Number`	`getMinimum()`	JSON Schema Validation: validation keyword
`java.lang.Integer`	`getMinItems()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Number`	`getMinLength()`	JSON Schema Validation: validation keyword
`java.lang.Integer`	`getMinProperties()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.Number`	`getMultipleOf()`	JSON Schema Validation: validation keyword
`@Nullable Schema`	`getNot()`	JSON Schema Validation: validation keyword
`java.lang.Boolean`	`getNullable()`	OpenAPI Schema
`java.util.Collection<Schema>`	`getOneOf()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.String`	`getPattern()`	JSON Schema Validation: validation keyword
`java.util.Map<java.lang.String,Schema>`	`getProperties()`	JSON Schema Validation: validation keyword
`java.lang.Boolean`	`getReadOnly()`	OpenAPI Schema
`java.lang.String`	`getRef()`	$ref value.
`Schema`	`getRefObject()`
`java.util.Collection<java.lang.String>`	`getRequired()`	JSON Schema Validation: validation keyword
`@Nullable java.lang.String`	`getTitle()`	JSON Schema Validation: metadata keyword
`java.lang.String`	`getType()`	JSON Schema Validation: validation keyword
`java.lang.Boolean`	`getUniqueItems()`	JSON Schema Validation: validation keyword
`java.lang.Boolean`	`getWriteOnly()`	OpenAPI Schema
`@Nullable Xml`	`getXml()`	OpenAPI Schema
`boolean`	`isRef()`	check if this is a $ref object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Schema
```
public Schema(Context context,
              io.openapiprocessor.jsonschema.schema.Bucket bucket)
```
- Method Detail
  - isRef
```
public boolean isRef()
```
    Description copied from interface: Reference
    
    check if this is a $ref object.
    
    Specified by:
    
    isRef in interface Reference
    
    Returns:
    
    true if $ref else false.
  - getRef
```
public java.lang.String getRef()
```
    Description copied from interface: Reference
    
    $ref value. Should be guarded by Reference.isRef(). Throws if Reference.isRef() is false.
    
    Specified by:
    
    getRef in interface Reference
    
    Returns:
    
    ref
  - getRefObject
```
public Schema getRefObject()
```
  - getMultipleOf
```
public @Nullable java.lang.Number getMultipleOf()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    multiple of or null if missing
  - getMaximum
```
public @Nullable java.lang.Number getMaximum()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    maximum or null if missing
  - getExclusiveMaximum
```
public java.lang.Boolean getExclusiveMaximum()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    exclusive maximum or false
  - getMinimum
```
public @Nullable java.lang.Number getMinimum()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    minimum or null if missing
  - getExclusiveMinimum
```
public java.lang.Boolean getExclusiveMinimum()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    exclusive minimum or false if missing
  - getMaxLength
```
public @Nullable java.lang.Number getMaxLength()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    max length or null if missing
  - getMinLength
```
public @Nullable java.lang.Number getMinLength()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    min length or null if missing
  - getItems
```
public @Nullable Schema getItems()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    items or null if missing
  - getPattern
```
public @Nullable java.lang.String getPattern()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    pattern or null if missing
  - getMaxItems
```
public @Nullable java.lang.Integer getMaxItems()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    max items or null if missing
  - getMinItems
```
public java.lang.Integer getMinItems()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    min items or 0 if missing
  - getUniqueItems
```
public java.lang.Boolean getUniqueItems()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    unique items or false if missing
  - getMaxProperties
```
public @Nullable java.lang.Integer getMaxProperties()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    max properties or null if missing
  - getMinProperties
```
public java.lang.Integer getMinProperties()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    min properties or 0 if missing
  - getRequired
```
public java.util.Collection<java.lang.String> getRequired()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    required properties or empty if missing
  - getProperties
```
public java.util.Map<java.lang.String,Schema> getProperties()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    properties map or empty if missing
  - getAdditionalProperties
```
public @Nullable java.lang.Object getAdditionalProperties()
```
    JSON Schema Validation: validation keyword. Boolean or Schema value.
    
    Returns:
    
    Boolean or Schema, true if missing
  - getEnum
```
public @Nullable java.util.Collection<?> getEnum()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    enum values or empty if missing todo any type
  - getType
```
@Required
public java.lang.String getType()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    type, throws if missing
  - getAllOf
```
public java.util.Collection<Schema> getAllOf()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    all of or empty if missing
  - getAnyOf
```
public java.util.Collection<Schema> getAnyOf()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    any of or empty if missing
  - getOneOf
```
public java.util.Collection<Schema> getOneOf()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    one of or empty if missing
  - getNot
```
public @Nullable Schema getNot()
```
    JSON Schema Validation: validation keyword
    
    Returns:
    
    not or null if missing
  - getTitle
```
public @Nullable java.lang.String getTitle()
```
    JSON Schema Validation: metadata keyword
    
    Returns:
    
    title or null if missing
  - getDescription
```
public @Nullable java.lang.String getDescription()
```
    JSON Schema Validation: metadata keyword. May contain Markdown formatting (common mark).
    
    Returns:
    
    description or null if missing
  - getDefault
```
public @Nullable java.lang.Object getDefault()
```
    JSON Schema Validation: metadata keyword
    
    Returns:
    
    default or null
  - getFormat
```
public @Nullable java.lang.String getFormat()
```
    JSON Schema Validation: semantic validation keyword
    
    Returns:
    
    format or null if missing
  - getNullable
```
public java.lang.Boolean getNullable()
```
    OpenAPI Schema
    
    Returns:
    
    nullable or false if missing
  - getDiscriminator
```
public @Nullable Discriminator getDiscriminator()
```
    OpenAPI Schema
    
    Returns:
    
    discriminator or null if missing
  - getReadOnly
```
public java.lang.Boolean getReadOnly()
```
    OpenAPI Schema
    
    Returns:
    
    true or false
  - getWriteOnly
```
public java.lang.Boolean getWriteOnly()
```
    OpenAPI Schema
    
    Returns:
    
    true or false
  - getXml
```
public @Nullable Xml getXml()
```
    OpenAPI Schema
    
    Returns:
    
    xml or null if missing
  - getExternalDocs
```
public @Nullable ExternalDocumentation getExternalDocs()
```
    OpenAPI Schema
    
    Returns:
    
    external documentation or null if missing
  - getExample
```
public @Nullable java.lang.Object getExample()
```
    OpenAPI Schema
    
    Returns:
    
    example or null if missing
  - getDeprecated
```
public java.lang.Boolean getDeprecated()
```
    OpenAPI Schema
    
    Returns:
    
    deprecated or false if missing
  - getExtensions
```
public java.util.Map<java.lang.String,java.lang.Object> getExtensions()
```
    Description copied from interface: Extensions
    
    map of all extension properties.
    
    Specified by:
    
    getExtensions in interface Extensions
    
    Overrides:
    
    getExtensions in class Properties
    
    Returns:
    
    map of extension properties

Class Schema

Field Summary

Fields inherited from class io.openapiparser.Properties

Constructor Summary

Method Summary

Methods inherited from class io.openapiparser.Properties

Methods inherited from class java.lang.Object

Constructor Detail

Schema

Method Detail

isRef

getRef

getRefObject

getMultipleOf

getMaximum

getExclusiveMaximum

getMinimum

getExclusiveMinimum

getMaxLength

getMinLength

getItems

getPattern

getMaxItems

getMinItems

getUniqueItems

getMaxProperties

getMinProperties

getRequired

getProperties

getAdditionalProperties

getEnum

getType

getAllOf

getAnyOf

getOneOf

getNot

getTitle

getDescription

getDefault

getFormat

getNullable

getDiscriminator

getReadOnly

getWriteOnly

getXml

getExternalDocs

getExample

getDeprecated

getExtensions