Schema (Apache Juneau 7.1.1)

java.lang.Object
- org.apache.juneau.dto.jsonschema.Schema

Direct Known Subclasses:: SchemaProperty, SchemaRef

@Bean(typeName="schema",
      properties="id,$schema,$ref, title,description,type,definitions,properties,patternProperties,dependencies,items,multipleOf,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,additionalItems,maxItems,minItems,uniqueItems,maxProperties,minProperties,required,additionalProperties,enum,allOf,anyOf,oneOf,not")
public class Schema
extends Object

Represents a top-level schema object bean in the JSON-Schema core specification.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Schema.BooleanOrSchemaArraySwap` Used during parsing to convert the additionalItems property to the correct class type.
`static class`	`Schema.BooleanOrSchemaSwap` Used during parsing to convert the additionalProperties property to the correct class type.
`static class`	`Schema.JsonTypeOrJsonTypeArraySwap` Used during parsing to convert the type property to the correct class type.
`static class`	`Schema.SchemaOrSchemaArraySwap` Used during parsing to convert the items property to the correct class type.

Constructor Summary

Constructors
Constructor and Description

Schema()
Default constructor.

Constructors
Constructor and Description
`Schema()` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Schema`	`addAdditionalItems(Schema... additionalItems)` Bean property appender: additionalItems.
`Schema`	`addAllOf(Schema... allOf)` Bean property appender: allOf.
`Schema`	`addAnyOf(Schema... anyOf)` Bean property appender: anyOf.
`Schema`	`addDefinition(String name, Schema definition)` Bean property appender: definitions.
`Schema`	`addDependency(String name, Schema dependency)` Bean property appender: dependencies.
`Schema`	`addEnum(String... _enum)` Bean property appender: enum.
`Schema`	`addItems(Schema... items)` Bean property appender: items.
`Schema`	`addOneOf(Schema... oneOf)` Bean property appender: oneOf.
`Schema`	`addPatternProperties(SchemaProperty... properties)` Bean property appender: patternProperties.
`Schema`	`addProperties(Schema... properties)` Bean property appender: properties.
`Schema`	`addRequired(List<String> required)` Bean property appender: required.
`Schema`	`addRequired(SchemaProperty... properties)` Bean property appender: required.
`Schema`	`addRequired(String... required)` Bean property appender: required.
`Schema`	`addTypes(JsonType... types)` Bean property appender: type.
`Object`	`getAdditionalItems()` Bean property getter: additionalItems.
`Boolean`	`getAdditionalItemsAsBoolean()` Bean property getter: additionalItems.
`List<Schema>`	`getAdditionalItemsAsSchemaArray()` Bean property getter: additionalItems.
`Object`	`getAdditionalProperties()` Bean property getter: additionalProperties.
`Boolean`	`getAdditionalPropertiesAsBoolean()` Bean property getter: additionalProperties.
`Schema`	`getAdditionalPropertiesAsSchema()` Bean property getter: additionalProperties.
`List<Schema>`	`getAllOf()` Bean property getter: allOf.
`List<Schema>`	`getAnyOf()` Bean property getter: anyOf.
`Map<String,Schema>`	`getDefinitions()` Bean property getter: definitions.
`Map<String,Schema>`	`getDependencies()` Bean property getter: dependencies.
`String`	`getDescription()` Bean property getter: description.
`List<String>`	`getEnum()` Bean property getter: enum.
`URI`	`getId()` Bean property getter: id.
`Object`	`getItems()` Bean property getter: items.
`Schema`	`getItemsAsSchema()` Bean property getter: items.
`SchemaArray`	`getItemsAsSchemaArray()` Bean property getter: items.
`Number`	`getMaximum()` Bean property getter: maximum.
`Integer`	`getMaxItems()` Bean property getter: maxItems.
`Integer`	`getMaxLength()` Bean property getter: maxLength.
`Integer`	`getMaxProperties()` Bean property getter: maxProperties.
`Number`	`getMinimum()` Bean property getter: minimum.
`Integer`	`getMinItems()` Bean property getter: minItems.
`Integer`	`getMinLength()` Bean property getter: minLength.
`Integer`	`getMinProperties()` Bean property getter: minProperties.
`Number`	`getMultipleOf()` Bean property getter: multipleOf.
`String`	`getName()` Bean property getter: name.
`Schema`	`getNot()` Bean property getter: not.
`List<Schema>`	`getOneOf()` Bean property getter: oneOf.
`String`	`getPattern()` Bean property getter: pattern.
`Map<String,Schema>`	`getPatternProperties()` Bean property getter: patternProperties.
`Map<String,Schema>`	`getProperties()` Bean property getter: properties.
`Schema`	`getProperty(String name)` Returns the property with the specified name.
`Schema`	`getProperty(String name, boolean resolve)` Returns the property with the specified name.
`URI`	`getRef()` Bean property getter: $ref.
`List<String>`	`getRequired()` Bean property getter: required.
`URI`	`getSchemaVersionUri()` Bean property getter: $schema.
`String`	`getTitle()` Bean property getter: title.
`Object`	`getType()` Bean property getter: type.
`JsonType`	`getTypeAsJsonType()` Bean property getter: type.
`JsonTypeArray`	`getTypeAsJsonTypeArray()` Bean property getter: type.
`Boolean`	`getUniqueItems()` Bean property getter: uniqueItems.
`Boolean`	`isExclusiveMaximum()` Bean property getter: exclusiveMaximum.
`Boolean`	`isExclusiveMinimum()` Bean property getter: exclusiveMinimum.
`Schema`	`resolve()` If this schema is a reference to another schema (i.e.
`Schema`	`setAdditionalItems(Object additionalItems)` Bean property setter: additionalItems.
`Schema`	`setAdditionalProperties(Object additionalProperties)` Bean property setter: additionalProperties.
`Schema`	`setAllOf(List<Schema> allOf)` Bean property setter: allOf.
`Schema`	`setAnyOf(List<Schema> anyOf)` Bean property setter: anyOf.
`Schema`	`setDefinitions(Map<String,Schema> definitions)` Bean property setter: definitions.
`Schema`	`setDependencies(Map<String,Schema> dependencies)` Bean property setter: dependencies.
`Schema`	`setDescription(String description)` Bean property setter: description.
`Schema`	`setEnum(List<String> _enum)` Bean property setter: enum.
`Schema`	`setExclusiveMaximum(Boolean exclusiveMaximum)` Bean property setter: exclusiveMaximum.
`Schema`	`setExclusiveMinimum(Boolean exclusiveMinimum)` Bean property setter: exclusiveMinimum.
`Schema`	`setId(Object id)` Bean property setter: id.
`Schema`	`setItems(Object items)` Bean property setter: items.
`protected void`	`setMaster(Schema master)` Sets the master schema for this schema and all child schema objects.
`Schema`	`setMaximum(Number maximum)` Bean property setter: maximum.
`Schema`	`setMaxItems(Integer maxItems)` Bean property setter: maxItems.
`Schema`	`setMaxLength(Integer maxLength)` Bean property setter: maxLength.
`Schema`	`setMaxProperties(Integer maxProperties)` Bean property setter: maxProperties.
`Schema`	`setMinimum(Number minimum)` Bean property setter: minimum.
`Schema`	`setMinItems(Integer minItems)` Bean property setter: minItems.
`Schema`	`setMinLength(Integer minLength)` Bean property setter: minLength.
`Schema`	`setMinProperties(Integer minProperties)` Bean property setter: minProperties.
`Schema`	`setMultipleOf(Number multipleOf)` Bean property setter: multipleOf.
`Schema`	`setName(String name)` Bean property setter: name.
`Schema`	`setNot(Schema not)` Bean property setter: not.
`Schema`	`setOneOf(List<Schema> oneOf)` Bean property setter: oneOf.
`Schema`	`setPattern(String pattern)` Bean property setter: pattern.
`Schema`	`setPatternProperties(Map<String,Schema> patternProperties)` Bean property setter: patternProperties.
`Schema`	`setProperties(Map<String,Schema> properties)` Bean property setter: properties.
`Schema`	`setRef(Object ref)` Bean property setter: $ref.
`Schema`	`setRequired(List<String> required)` Bean property setter: required.
`Schema`	`setSchemaMap(SchemaMap schemaMap)` Associates a schema map with this schema for resolving other schemas identified through $ref properties.
`Schema`	`setSchemaVersionUri(Object schemaVersion)` Bean property setter: $schema.
`Schema`	`setTitle(String title)` Bean property setter: title.
`Schema`	`setType(Object type)` Bean property setter: type.
`Schema`	`setUniqueItems(Boolean uniqueItems)` Bean property setter: uniqueItems.
`String`	`toString()`

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

- Constructor Detail
  - Schema
```
public Schema()
```
    Default constructor.
- Method Detail
  - getName
```
@BeanIgnore
public String getName()
```
    Bean property getter: name.
    
    Returns:
    
    The value of the name property on this bean, or null if it is not set.
  - setName
```
@BeanIgnore
public Schema setName(String name)
```
    Bean property setter: name.
    
    Parameters:
    
    name - The new value for the name property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getId
```
public URI getId()
```
    Bean property getter: id.
    
    Returns:
    
    The value of the id property on this bean, or null if it is not set.
  - setId
```
public Schema setId(Object id)
```
    Bean property setter: id.
    The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.
    URIs defined by UriResolver can be used for values.
    
    Parameters:
    
    id - The new value for the id property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getSchemaVersionUri
```
@BeanProperty(value="$schema")
public URI getSchemaVersionUri()
```
    Bean property getter: $schema.
    
    Returns:
    
    The value of the $schema property on this bean, or null if it is not set.
  - setSchemaVersionUri
```
@BeanProperty(value="$schema")
public Schema setSchemaVersionUri(Object schemaVersion)
```
    Bean property setter: $schema.
    The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.
    URIs defined by UriResolver can be used for values.
    
    Parameters:
    
    schemaVersion - The new value for the schemaVersion property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getTitle
```
public String getTitle()
```
    Bean property getter: title.
    
    Returns:
    
    The value of the title property, or null if it is not set.
  - setTitle
```
public Schema setTitle(String title)
```
    Bean property setter: title.
    
    Parameters:
    
    title - The new value for the title property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getDescription
```
public String getDescription()
```
    Bean property getter: description.
    
    Returns:
    
    The value of the description property, or null if it is not set.
  - setDescription
```
public Schema setDescription(String description)
```
    Bean property setter: description.
    
    Parameters:
    
    description - The new value for the description property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getType
```
@Swap(value=Schema.JsonTypeOrJsonTypeArraySwap.class)
public Object getType()
```
    Bean property getter: type.
    
    Returns:
    
    The value of the type property on this bean, or null if it is not set. Can be either a JsonType or JsonTypeArray depending on what value was used to set it.
  - getTypeAsJsonType
```
@BeanIgnore
public JsonType getTypeAsJsonType()
```
    Bean property getter: type.
    Convenience method for returning the type property when it is a JsonType value.
    
    Returns:
    
    The currently set value, or null if the property is not set, or is set as a JsonTypeArray.
  - getTypeAsJsonTypeArray
```
@BeanIgnore
public JsonTypeArray getTypeAsJsonTypeArray()
```
    Bean property getter: type.
    Convenience method for returning the type property when it is a JsonTypeArray value.
    
    Returns:
    
    The currently set value, or null if the property is not set, or is set as a JsonType.
  - setType
```
public Schema setType(Object type)
```
    Bean property setter: type.
    
    Parameters:
    
    type - The new value for the type property on this bean. This object must be of type JsonType or JsonTypeArray.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    BeanRuntimeException - If invalid object type passed in.
  - addTypes
```
public Schema addTypes(JsonType... types)
```
    Bean property appender: type.
    
    Parameters:
    
    types - The list of items to append to the type property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getDefinitions
```
public Map<String,Schema> getDefinitions()
```
    Bean property getter: definitions.
    
    Returns:
    
    The value of the definitions property on this bean, or null if it is not set.
  - setDefinitions
```
public Schema setDefinitions(Map<String,Schema> definitions)
```
    Bean property setter: definitions.
    
    Parameters:
    
    definitions - The new value for the definitions property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addDefinition
```
public Schema addDefinition(String name,
                            Schema definition)
```
    Bean property appender: definitions.
    
    Parameters:
    
    name - The key in the definitions map entry.
    
    definition - The value in the definitions map entry.
    
    Returns:
    
    This object (for method chaining).
  - getProperties
```
public Map<String,Schema> getProperties()
```
    Bean property getter: properties.
    
    Returns:
    
    The value of the properties property on this bean, or null if it is not set.
  - getProperty
```
public Schema getProperty(String name)
```
    Returns the property with the specified name.
    This is equivalent to calling getProperty(name, false).
    
    Parameters:
    
    name - The property name.
    
    Returns:
    
    The property with the specified name, or null if no property is specified.
  - getProperty
```
public Schema getProperty(String name,
                          boolean resolve)
```
    Returns the property with the specified name.
    If resolve is true, the property object will automatically be resolved by calling resolve(). Therefore, getProperty(name, true) is equivalent to calling getProperty(name).resolve(), except it's safe from a potential NullPointerException.
    
    Parameters:
    
    name - The property name.
    
    resolve - If true, calls resolve() on object before returning.
    
    Returns:
    
    The property with the specified name, or null if no property is specified.
  - setProperties
```
public Schema setProperties(Map<String,Schema> properties)
```
    Bean property setter: properties.
    
    Parameters:
    
    properties - The new value for the properties property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addProperties
```
public Schema addProperties(Schema... properties)
```
    Bean property appender: properties.
    Properties must have their name property set on them when using this method.
    
    Parameters:
    
    properties - The list of items to append to the properties property on this bean.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    BeanRuntimeException - If property is found without a set name property.
  - getPatternProperties
```
public Map<String,Schema> getPatternProperties()
```
    Bean property getter: patternProperties.
    
    Returns:
    
    The value of the patternProperties property on this bean, or null if it is not set.
  - setPatternProperties
```
public Schema setPatternProperties(Map<String,Schema> patternProperties)
```
    Bean property setter: patternProperties.
    
    Parameters:
    
    patternProperties - The new value for the patternProperties property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addPatternProperties
```
public Schema addPatternProperties(SchemaProperty... properties)
```
    Bean property appender: patternProperties.
    Properties must have their name property set to the pattern string when using this method.
    
    Parameters:
    
    properties - The list of items to append to the patternProperties property on this bean.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    BeanRuntimeException - If property is found without a set name property.
  - getDependencies
```
public Map<String,Schema> getDependencies()
```
    Bean property getter: dependencies.
    
    Returns:
    
    The value of the dependencies property on this bean, or null if it is not set.
  - setDependencies
```
public Schema setDependencies(Map<String,Schema> dependencies)
```
    Bean property setter: dependencies.
    
    Parameters:
    
    dependencies - The new value for the dependencies property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addDependency
```
public Schema addDependency(String name,
                            Schema dependency)
```
    Bean property appender: dependencies.
    
    Parameters:
    
    name - The key of the entry in the dependencies map.
    
    dependency - The value of the entry in the dependencies map.
    
    Returns:
    
    This object (for method chaining).
  - getItems
```
@Swap(value=Schema.SchemaOrSchemaArraySwap.class)
public Object getItems()
```
    Bean property getter: items.
    
    Returns:
    
    The value of the items property on this bean, or null if it is not set. Can be either a Schema or SchemaArray depending on what value was used to set it.
  - getItemsAsSchema
```
@BeanIgnore
public Schema getItemsAsSchema()
```
    Bean property getter: items.
    Convenience method for returning the items property when it is a Schema value.
    
    Returns:
    
    The currently set value, or null if the property is not set, or is set as a SchemaArray.
  - getItemsAsSchemaArray
```
@BeanIgnore
public SchemaArray getItemsAsSchemaArray()
```
    Bean property getter: items.
    Convenience method for returning the items property when it is a SchemaArray value.
    
    Returns:
    
    The currently set value, or null if the property is not set, or is set as a Schema.
  - setItems
```
public Schema setItems(Object items)
```
    Bean property setter: items.
    
    Parameters:
    
    items - The new value for the items property on this bean. This object must be of type Schema or SchemaArray.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    BeanRuntimeException - If invalid object type passed in.
  - addItems
```
public Schema addItems(Schema... items)
```
    Bean property appender: items.
    
    Parameters:
    
    items - The list of items to append to the items property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMultipleOf
```
public Number getMultipleOf()
```
    Bean property getter: multipleOf.
    
    Returns:
    
    The value of the multipleOf property on this bean, or null if it is not set.
  - setMultipleOf
```
public Schema setMultipleOf(Number multipleOf)
```
    Bean property setter: multipleOf.
    
    Parameters:
    
    multipleOf - The new value for the multipleOf property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMaximum
```
public Number getMaximum()
```
    Bean property getter: maximum.
    
    Returns:
    
    The value of the maximum property on this bean, or null if it is not set.
  - setMaximum
```
public Schema setMaximum(Number maximum)
```
    Bean property setter: maximum.
    
    Parameters:
    
    maximum - The new value for the maximum property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - isExclusiveMaximum
```
public Boolean isExclusiveMaximum()
```
    Bean property getter: exclusiveMaximum.
    
    Returns:
    
    The value of the exclusiveMaximum property on this bean, or null if it is not set.
  - setExclusiveMaximum
```
public Schema setExclusiveMaximum(Boolean exclusiveMaximum)
```
    Bean property setter: exclusiveMaximum.
    
    Parameters:
    
    exclusiveMaximum - The new value for the exclusiveMaximum property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMinimum
```
public Number getMinimum()
```
    Bean property getter: minimum.
    
    Returns:
    
    The value of the minimum property on this bean, or null if it is not set.
  - setMinimum
```
public Schema setMinimum(Number minimum)
```
    Bean property setter: minimum.
    
    Parameters:
    
    minimum - The new value for the minimum property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - isExclusiveMinimum
```
public Boolean isExclusiveMinimum()
```
    Bean property getter: exclusiveMinimum.
    
    Returns:
    
    The value of the exclusiveMinimum property on this bean, or null if it is not set.
  - setExclusiveMinimum
```
public Schema setExclusiveMinimum(Boolean exclusiveMinimum)
```
    Bean property setter: exclusiveMinimum.
    
    Parameters:
    
    exclusiveMinimum - The new value for the exclusiveMinimum property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMaxLength
```
public Integer getMaxLength()
```
    Bean property getter: maxLength.
    
    Returns:
    
    The value of the maxLength property on this bean, or null if it is not set.
  - setMaxLength
```
public Schema setMaxLength(Integer maxLength)
```
    Bean property setter: maxLength.
    
    Parameters:
    
    maxLength - The new value for the maxLength property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMinLength
```
public Integer getMinLength()
```
    Bean property getter: minLength.
    
    Returns:
    
    The value of the minLength property on this bean, or null if it is not set.
  - setMinLength
```
public Schema setMinLength(Integer minLength)
```
    Bean property setter: minLength.
    
    Parameters:
    
    minLength - The new value for the minLength property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getPattern
```
public String getPattern()
```
    Bean property getter: pattern.
    
    Returns:
    
    The value of the pattern property on this bean, or null if it is not set.
  - setPattern
```
public Schema setPattern(String pattern)
```
    Bean property setter: pattern.
    
    Parameters:
    
    pattern - The new value for the pattern property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getAdditionalItems
```
@Swap(value=Schema.BooleanOrSchemaArraySwap.class)
public Object getAdditionalItems()
```
    Bean property getter: additionalItems.
    
    Returns:
    
    The value of the additionalItems property on this bean, or null if it is not set. Can be either a Boolean or SchemaArray depending on what value was used to set it.
  - getAdditionalItemsAsBoolean
```
@BeanIgnore
public Boolean getAdditionalItemsAsBoolean()
```
    Bean property getter: additionalItems.
    Convenience method for returning the additionalItems property when it is a Boolean value.
    
    Returns:
    
    The currently set value, or null if the property is not set, or is set as a SchemaArray.
  - getAdditionalItemsAsSchemaArray
```
@BeanIgnore
public List<Schema> getAdditionalItemsAsSchemaArray()
```
    Bean property getter: additionalItems.
    Convenience method for returning the additionalItems property when it is a SchemaArray value.
    
    Returns:
    
    The currently set value, or null if the property is not set, or is set as a Boolean.
  - setAdditionalItems
```
public Schema setAdditionalItems(Object additionalItems)
```
    Bean property setter: additionalItems.
    
    Parameters:
    
    additionalItems - The new value for the additionalItems property on this bean. This object must be of type Boolean or SchemaArray.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    BeanRuntimeException - If invalid object type passed in.
  - addAdditionalItems
```
public Schema addAdditionalItems(Schema... additionalItems)
```
    Bean property appender: additionalItems.
    
    Parameters:
    
    additionalItems - The list of items to append to the additionalItems property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMaxItems
```
public Integer getMaxItems()
```
    Bean property getter: maxItems.
    
    Returns:
    
    The value of the maxItems property on this bean, or null if it is not set.
  - setMaxItems
```
public Schema setMaxItems(Integer maxItems)
```
    Bean property setter: maxItems.
    
    Parameters:
    
    maxItems - The new value for the maxItems property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMinItems
```
public Integer getMinItems()
```
    Bean property getter: minItems.
    
    Returns:
    
    The value of the minItems property on this bean, or null if it is not set.
  - setMinItems
```
public Schema setMinItems(Integer minItems)
```
    Bean property setter: minItems.
    
    Parameters:
    
    minItems - The new value for the minItems property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getUniqueItems
```
public Boolean getUniqueItems()
```
    Bean property getter: uniqueItems.
    
    Returns:
    
    The value of the uniqueItems property on this bean, or null if it is not set.
  - setUniqueItems
```
public Schema setUniqueItems(Boolean uniqueItems)
```
    Bean property setter: uniqueItems.
    
    Parameters:
    
    uniqueItems - The new value for the uniqueItems property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMaxProperties
```
public Integer getMaxProperties()
```
    Bean property getter: maxProperties.
    
    Returns:
    
    The value of the maxProperties property on this bean, or null if it is not set.
  - setMaxProperties
```
public Schema setMaxProperties(Integer maxProperties)
```
    Bean property setter: maxProperties.
    
    Parameters:
    
    maxProperties - The new value for the maxProperties property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getMinProperties
```
public Integer getMinProperties()
```
    Bean property getter: minProperties.
    
    Returns:
    
    The value of the minProperties property on this bean, or null if it is not set.
  - setMinProperties
```
public Schema setMinProperties(Integer minProperties)
```
    Bean property setter: minProperties.
    
    Parameters:
    
    minProperties - The new value for the minProperties property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getRequired
```
public List<String> getRequired()
```
    Bean property getter: required.
    
    Returns:
    
    The value of the required property on this bean, or null if it is not set.
  - setRequired
```
public Schema setRequired(List<String> required)
```
    Bean property setter: required.
    
    Parameters:
    
    required - The new value for the required property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addRequired
```
public Schema addRequired(List<String> required)
```
    Bean property appender: required.
    
    Parameters:
    
    required - The list of items to append to the required property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addRequired
```
public Schema addRequired(String... required)
```
    Bean property appender: required.
    
    Parameters:
    
    required - The list of items to append to the required property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addRequired
```
public Schema addRequired(SchemaProperty... properties)
```
    Bean property appender: required.
    
    Parameters:
    
    properties - The list of items to append to the required property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getAdditionalProperties
```
@Swap(value=Schema.BooleanOrSchemaSwap.class)
public Object getAdditionalProperties()
```
    Bean property getter: additionalProperties.
    
    Returns:
    
    The value of the additionalProperties property on this bean, or null if it is not set. Can be either a Boolean or SchemaArray depending on what value was used to set it.
  - getAdditionalPropertiesAsBoolean
```
@BeanIgnore
public Boolean getAdditionalPropertiesAsBoolean()
```
    Bean property getter: additionalProperties.
    Convenience method for returning the additionalProperties property when it is a Boolean value.
    
    Returns:
    
    The currently set value, or null if the property is not set, or is set as a Schema.
  - getAdditionalPropertiesAsSchema
```
@BeanIgnore
public Schema getAdditionalPropertiesAsSchema()
```
    Bean property getter: additionalProperties.
    Convenience method for returning the additionalProperties property when it is a Schema value.
    
    Returns:
    
    The currently set value, or null if the property is not set, or is set as a Boolean.
  - setAdditionalProperties
```
@BeanProperty(beanDictionary=Schema.class)
public Schema setAdditionalProperties(Object additionalProperties)
```
    Bean property setter: additionalProperties.
    
    Parameters:
    
    additionalProperties - The new value for the additionalProperties property on this bean. This object must be of type Boolean or Schema.
    
    Returns:
    
    This object (for method chaining).
    
    Throws:
    
    BeanRuntimeException - If invalid object type passed in.
  - getEnum
```
public List<String> getEnum()
```
    Bean property getter: enum.
    
    Returns:
    
    The value of the enum property on this bean, or null if it is not set.
  - setEnum
```
public Schema setEnum(List<String> _enum)
```
    Bean property setter: enum.
    
    Parameters:
    
    _enum - The new value for the enum property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addEnum
```
public Schema addEnum(String... _enum)
```
    Bean property appender: enum.
    
    Parameters:
    
    _enum - The list of items to append to the enum property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getAllOf
```
public List<Schema> getAllOf()
```
    Bean property getter: allOf.
    
    Returns:
    
    The value of the allOf property on this bean, or null if it is not set.
  - setAllOf
```
public Schema setAllOf(List<Schema> allOf)
```
    Bean property setter: allOf.
    
    Parameters:
    
    allOf - The new value for the allOf property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addAllOf
```
public Schema addAllOf(Schema... allOf)
```
    Bean property appender: allOf.
    
    Parameters:
    
    allOf - The list of items to append to the allOf property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getAnyOf
```
public List<Schema> getAnyOf()
```
    Bean property getter: anyOf.
    
    Returns:
    
    The value of the anyOf property on this bean, or null if it is not set.
  - setAnyOf
```
public Schema setAnyOf(List<Schema> anyOf)
```
    Bean property setter: anyOf.
    
    Parameters:
    
    anyOf - The new value of the anyOf property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addAnyOf
```
public Schema addAnyOf(Schema... anyOf)
```
    Bean property appender: anyOf.
    
    Parameters:
    
    anyOf - The list of items to append to the anyOf property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getOneOf
```
public List<Schema> getOneOf()
```
    Bean property getter: oneOf.
    
    Returns:
    
    The value of the oneOf property on this bean, or null if it is not set.
  - setOneOf
```
public Schema setOneOf(List<Schema> oneOf)
```
    Bean property setter: oneOf.
    
    Parameters:
    
    oneOf - The new value for the oneOf property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - addOneOf
```
public Schema addOneOf(Schema... oneOf)
```
    Bean property appender: oneOf.
    
    Parameters:
    
    oneOf - The list of items to append to the oneOf property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getNot
```
public Schema getNot()
```
    Bean property getter: not.
    
    Returns:
    
    The value of the not property on this bean, or null if it is not set.
  - setNot
```
public Schema setNot(Schema not)
```
    Bean property setter: not.
    
    Parameters:
    
    not - The new value for the not property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - getRef
```
@BeanProperty(value="$ref")
public URI getRef()
```
    Bean property getter: $ref.
    
    Returns:
    
    The value of the $ref property on this bean, or null if it is not set.
  - setRef
```
@BeanProperty(value="$ref")
public Schema setRef(Object ref)
```
    Bean property setter: $ref.
    The value can be of any of the following types: URI, URL, String. Strings must be valid URIs.
    URIs defined by UriResolver can be used for values.
    
    Parameters:
    
    ref - The new value for the $ref property on this bean.
    
    Returns:
    
    This object (for method chaining).
  - setMaster
```
protected void setMaster(Schema master)
```
    Sets the master schema for this schema and all child schema objects.
    All child elements in a schema should point to a single "master" schema in order to locate registered SchemaMap objects for resolving external schemas.
    
    Parameters:
    
    master - The master schema to associate on this and all children. Can be null.
  - resolve
```
public Schema resolve()
```
    If this schema is a reference to another schema (i.e. has its $ref property set), this method will retrieve the referenced schema from the schema map registered with this schema.
    If this schema is not a reference, or no schema map is registered with this schema, this method is a no-op and simply returns this object.
    
    Returns:
    
    The referenced schema, or null.
  - setSchemaMap
```
public Schema setSchemaMap(SchemaMap schemaMap)
```
    Associates a schema map with this schema for resolving other schemas identified through $ref properties.
    
    Parameters:
    
    schemaMap - The schema map to associate with this schema. Can be null.
    
    Returns:
    
    This object (for method chaining).
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Schema

See Also:

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Schema

Method Detail

getName

setName

getId

setId

getSchemaVersionUri

setSchemaVersionUri

getTitle

setTitle

getDescription

setDescription

getType

getTypeAsJsonType

getTypeAsJsonTypeArray

setType

addTypes

getDefinitions

setDefinitions

addDefinition

getProperties

getProperty

getProperty

setProperties

addProperties

getPatternProperties

setPatternProperties

addPatternProperties

getDependencies

setDependencies

addDependency

getItems

getItemsAsSchema

getItemsAsSchemaArray

setItems

addItems

getMultipleOf

setMultipleOf

getMaximum

setMaximum

isExclusiveMaximum

setExclusiveMaximum

getMinimum

setMinimum

isExclusiveMinimum

setExclusiveMinimum

getMaxLength

setMaxLength

getMinLength

setMinLength

getPattern

setPattern

getAdditionalItems

getAdditionalItemsAsBoolean

getAdditionalItemsAsSchemaArray

setAdditionalItems

addAdditionalItems

getMaxItems

setMaxItems

getMinItems

setMinItems

getUniqueItems

setUniqueItems

getMaxProperties

setMaxProperties

getMinProperties

setMinProperties

getRequired

setRequired

addRequired

addRequired

addRequired

getAdditionalProperties