SchemaObject (mu-server 0.60.6 API)

java.lang.Object
- io.muserver.openapi.SchemaObject

public class SchemaObject
extends Object

See Also:: SchemaObjectBuilder

Field Summary

Fields
Modifier and Type	Field and Description
`Object`	`additionalProperties` Deprecated. use `additionalProperties()` instead
`List<SchemaObject>`	`allOf` Deprecated. use `allOf()` instead
`List<SchemaObject>`	`anyOf` Deprecated. use `anyOf()` instead
`Object`	`defaultValue` Deprecated. use `defaultValue()` instead
`Boolean`	`deprecated` Deprecated. use `deprecated()` instead
`String`	`description` Deprecated. use `description()` instead
`DiscriminatorObject`	`discriminator` Deprecated. use `discriminator()` instead
`List<Object>`	`enumValue` Deprecated. use `enumValue()` instead
`Object`	`example` Deprecated. use `example()` instead
`Boolean`	`exclusiveMaximum` Deprecated. use `exclusiveMaximum()` instead
`Boolean`	`exclusiveMinimum` Deprecated. use `exclusiveMinimum()` instead
`ExternalDocumentationObject`	`externalDocs` Deprecated. use `externalDocs()` instead
`String`	`format` Deprecated. use `format()` instead
`SchemaObject`	`items` Deprecated. use `items()` instead
`Double`	`maximum` Deprecated. use `maximum()` instead
`Integer`	`maxItems` Deprecated. use `maxItems()` instead
`Integer`	`maxLength` Deprecated. use `maxLength()` instead
`Integer`	`maxProperties` Deprecated. use `maxProperties()` instead
`Double`	`minimum` Deprecated. use `minimum()` instead
`Integer`	`minItems` Deprecated. use `minItems()` instead
`Integer`	`minLength` Deprecated. use `minLength()` instead
`Integer`	`minProperties` Deprecated. use `minProperties()` instead
`Double`	`multipleOf` Deprecated. use `multipleOf()` instead
`List<SchemaObject>`	`not` Deprecated. use `not()` instead
`Boolean`	`nullable` Deprecated. use `nullable()` instead
`List<SchemaObject>`	`oneOf` Deprecated. use `oneOf()` instead
`Pattern`	`pattern` Deprecated. use `pattern()` instead
`Map<String,SchemaObject>`	`properties` Deprecated. use `properties()` instead
`Boolean`	`readOnly` Deprecated. use `readOnly()` instead
`List<String>`	`required` Deprecated. use `required()` instead
`String`	`title` Deprecated. use `title()` instead
`String`	`type` Deprecated. use `type()` instead
`Boolean`	`uniqueItems` Deprecated. use `uniqueItems()` instead
`Boolean`	`writeOnly` Deprecated. use `writeOnly()` instead
`XmlObject`	`xml` Deprecated. use `xml()` instead

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`additionalProperties()`
`List<SchemaObject>`	`allOf()`
`List<SchemaObject>`	`anyOf()`
`Object`	`defaultValue()`
`Boolean`	`deprecated()`
`String`	`description()`
`DiscriminatorObject`	`discriminator()`
`List<Object>`	`enumValue()`
`Object`	`example()`
`Boolean`	`exclusiveMaximum()`
`Boolean`	`exclusiveMinimum()`
`ExternalDocumentationObject`	`externalDocs()`
`String`	`format()`
`boolean`	`isDeprecated()`
`SchemaObject`	`items()`
`Double`	`maximum()`
`Integer`	`maxItems()`
`Integer`	`maxLength()`
`Integer`	`maxProperties()`
`Double`	`minimum()`
`Integer`	`minItems()`
`Integer`	`minLength()`
`Integer`	`minProperties()`
`Double`	`multipleOf()`
`List<SchemaObject>`	`not()`
`Boolean`	`nullable()`
`List<SchemaObject>`	`oneOf()`
`Pattern`	`pattern()`
`Map<String,SchemaObject>`	`properties()`
`Boolean`	`readOnly()`
`List<String>`	`required()`
`String`	`title()`
`SchemaObjectBuilder`	`toBuilder()`
`String`	`toString()`
`String`	`type()`
`Boolean`	`uniqueItems()`
`void`	`writeJson(Writer writer)` Writes this object as a JSON Object
`Boolean`	`writeOnly()`
`XmlObject`	`xml()`

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

- Field Detail
  - title
```
@Deprecated
public final String title
```
    Deprecated. use title() instead
  - multipleOf
```
@Deprecated
public final Double multipleOf
```
    Deprecated. use multipleOf() instead
  - maximum
```
@Deprecated
public final Double maximum
```
    Deprecated. use maximum() instead
  - exclusiveMaximum
```
@Deprecated
public final Boolean exclusiveMaximum
```
    Deprecated. use exclusiveMaximum() instead
  - minimum
```
@Deprecated
public final Double minimum
```
    Deprecated. use minimum() instead
  - exclusiveMinimum
```
@Deprecated
public final Boolean exclusiveMinimum
```
    Deprecated. use exclusiveMinimum() instead
  - maxLength
```
@Deprecated
public final Integer maxLength
```
    Deprecated. use maxLength() instead
  - minLength
```
@Deprecated
public final Integer minLength
```
    Deprecated. use minLength() instead
  - pattern
```
@Deprecated
public final Pattern pattern
```
    Deprecated. use pattern() instead
  - maxItems
```
@Deprecated
public final Integer maxItems
```
    Deprecated. use maxItems() instead
  - minItems
```
@Deprecated
public final Integer minItems
```
    Deprecated. use minItems() instead
  - uniqueItems
```
@Deprecated
public final Boolean uniqueItems
```
    Deprecated. use uniqueItems() instead
  - maxProperties
```
@Deprecated
public final Integer maxProperties
```
    Deprecated. use maxProperties() instead
  - minProperties
```
@Deprecated
public final Integer minProperties
```
    Deprecated. use minProperties() instead
  - required
```
@Deprecated
public final List<String> required
```
    Deprecated. use required() instead
  - enumValue
```
@Deprecated
public final List<Object> enumValue
```
    Deprecated. use enumValue() instead
  - type
```
@Deprecated
public final String type
```
    Deprecated. use type() instead
  - allOf
```
@Deprecated
public final List<SchemaObject> allOf
```
    Deprecated. use allOf() instead
  - oneOf
```
@Deprecated
public final List<SchemaObject> oneOf
```
    Deprecated. use oneOf() instead
  - anyOf
```
@Deprecated
public final List<SchemaObject> anyOf
```
    Deprecated. use anyOf() instead
  - not
```
@Deprecated
public final List<SchemaObject> not
```
    Deprecated. use not() instead
  - items
```
@Deprecated
public final SchemaObject items
```
    Deprecated. use items() instead
  - properties
```
@Deprecated
public final Map<String,SchemaObject> properties
```
    Deprecated. use properties() instead
  - additionalProperties
```
@Deprecated
public final Object additionalProperties
```
    Deprecated. use additionalProperties() instead
  - description
```
@Deprecated
public final String description
```
    Deprecated. use description() instead
  - format
```
@Deprecated
public final String format
```
    Deprecated. use format() instead
  - defaultValue
```
@Deprecated
public final Object defaultValue
```
    Deprecated. use defaultValue() instead
  - nullable
```
@Deprecated
public final Boolean nullable
```
    Deprecated. use nullable() instead
  - discriminator
```
@Deprecated
public final DiscriminatorObject discriminator
```
    Deprecated. use discriminator() instead
  - readOnly
```
@Deprecated
public final Boolean readOnly
```
    Deprecated. use readOnly() instead
  - writeOnly
```
@Deprecated
public final Boolean writeOnly
```
    Deprecated. use writeOnly() instead
  - xml
```
@Deprecated
public final XmlObject xml
```
    Deprecated. use xml() instead
  - externalDocs
```
@Deprecated
public final ExternalDocumentationObject externalDocs
```
    Deprecated. use externalDocs() instead
  - example
```
@Deprecated
public final Object example
```
    Deprecated. use example() instead
  - deprecated
```
@Deprecated
public final Boolean deprecated
```
    Deprecated. use deprecated() instead
- Method Detail
  - writeJson
```
public void writeJson(Writer writer)
               throws IOException
```
    Writes this object as a JSON Object
    
    Parameters:
    
    writer - The writer to write to
    
    Throws:
    
    IOException - Thrown if the writer throws this while writing
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toBuilder
```
public SchemaObjectBuilder toBuilder()
```
    Returns:
    
    A new builder with the values set based on this instance
  - isDeprecated
```
public boolean isDeprecated()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withDeprecated(Boolean), unless null was passed in which case this returns false
  - title
```
public String title()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withTitle(java.lang.String)
  - multipleOf
```
public Double multipleOf()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMultipleOf(java.lang.Double)
  - maximum
```
public Double maximum()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMaximum(java.lang.Double)
  - exclusiveMaximum
```
public Boolean exclusiveMaximum()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withExclusiveMaximum(java.lang.Boolean)
  - minimum
```
public Double minimum()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMinimum(java.lang.Double)
  - exclusiveMinimum
```
public Boolean exclusiveMinimum()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withExclusiveMinimum(java.lang.Boolean)
  - maxLength
```
public Integer maxLength()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMaxLength(java.lang.Integer)
  - minLength
```
public Integer minLength()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMinLength(java.lang.Integer)
  - pattern
```
public Pattern pattern()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withPattern(java.util.regex.Pattern)
  - maxItems
```
public Integer maxItems()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMaxItems(java.lang.Integer)
  - minItems
```
public Integer minItems()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMinItems(java.lang.Integer)
  - uniqueItems
```
public Boolean uniqueItems()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withUniqueItems(java.lang.Boolean)
  - maxProperties
```
public Integer maxProperties()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMaxProperties(java.lang.Integer)
  - minProperties
```
public Integer minProperties()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withMinProperties(java.lang.Integer)
  - required
```
public List<String> required()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withRequired(java.util.List<java.lang.String>)
  - enumValue
```
public List<Object> enumValue()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withEnumValue(java.util.List<java.lang.Object>)
  - type
```
public String type()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withType(java.lang.String)
  - allOf
```
public List<SchemaObject> allOf()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withAllOf(java.util.List<io.muserver.openapi.SchemaObject>)
  - oneOf
```
public List<SchemaObject> oneOf()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withOneOf(java.util.List<io.muserver.openapi.SchemaObject>)
  - anyOf
```
public List<SchemaObject> anyOf()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withAnyOf(java.util.List<io.muserver.openapi.SchemaObject>)
  - not
```
public List<SchemaObject> not()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withNot(java.util.List<io.muserver.openapi.SchemaObject>)
  - items
```
public SchemaObject items()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withItems(io.muserver.openapi.SchemaObject)
  - properties
```
public Map<String,SchemaObject> properties()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withProperties(java.util.Map<java.lang.String, io.muserver.openapi.SchemaObject>)
  - additionalProperties
```
public Object additionalProperties()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withAdditionalProperties(java.lang.Object)
  - description
```
public String description()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withDescription(java.lang.String)
  - format
```
public String format()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withFormat(java.lang.String)
  - defaultValue
```
public Object defaultValue()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withDefaultValue(java.lang.Object)
  - nullable
```
public Boolean nullable()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withNullable(java.lang.Boolean)
  - discriminator
```
public DiscriminatorObject discriminator()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withDiscriminator(io.muserver.openapi.DiscriminatorObject)
  - readOnly
```
public Boolean readOnly()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withReadOnly(java.lang.Boolean)
  - writeOnly
```
public Boolean writeOnly()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withWriteOnly(java.lang.Boolean)
  - xml
```
public XmlObject xml()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withXml(io.muserver.openapi.XmlObject)
  - externalDocs
```
public ExternalDocumentationObject externalDocs()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withExternalDocs(io.muserver.openapi.ExternalDocumentationObject)
  - example
```
public Object example()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withExample(java.lang.Object)
  - deprecated
```
public Boolean deprecated()
```
    Returns:
    
    the value described by SchemaObjectBuilder.withDeprecated(java.lang.Boolean)

Class SchemaObject

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

title

multipleOf

maximum

exclusiveMaximum

minimum

exclusiveMinimum

maxLength

minLength

pattern

maxItems

minItems

uniqueItems

maxProperties

minProperties

required

enumValue

type

allOf

oneOf

anyOf

not

items

properties

additionalProperties

description

format

defaultValue

nullable

discriminator

readOnly

writeOnly

xml

externalDocs

example

deprecated

Method Detail

writeJson

toString

toBuilder

isDeprecated

title

multipleOf

maximum

exclusiveMaximum

minimum

exclusiveMinimum

maxLength

minLength

pattern

maxItems

minItems

uniqueItems

maxProperties

minProperties

required

enumValue

type

allOf

oneOf

anyOf

not

items

properties

additionalProperties

description

format

defaultValue

nullable

discriminator

readOnly

writeOnly

xml

externalDocs

example

deprecated