SchemaObjectBuilder (mu-server 0.18.6 API)

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

```
public class SchemaObjectBuilder
extends Object
```
The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00.

For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema.

Constructor Summary

Constructors
Constructor and Description

SchemaObjectBuilder()

Constructors
Constructor and Description
`SchemaObjectBuilder()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SchemaObject`	`build()`
`static SchemaObjectBuilder`	`schemaObject()` Creates a builder for a `SchemaObject`
`static SchemaObjectBuilder`	`schemaObjectFrom(Class<?> from)` Creates a builder for a `SchemaObject` with the type and format based on the given class
`SchemaObjectBuilder`	`withAdditionalProperties(Object additionalProperties)`
`SchemaObjectBuilder`	`withAllOf(List<SchemaObject> allOf)`
`SchemaObjectBuilder`	`withAnyOf(List<SchemaObject> anyOf)`
`SchemaObjectBuilder`	`withDefaultValue(Object defaultValue)`
`SchemaObjectBuilder`	`withDeprecated(Boolean deprecated)`
`SchemaObjectBuilder`	`withDescription(String description)`
`SchemaObjectBuilder`	`withDiscriminator(DiscriminatorObject discriminator)`
`SchemaObjectBuilder`	`withEnumValue(List<Object> enumValue)`
`SchemaObjectBuilder`	`withExample(Object example)`
`SchemaObjectBuilder`	`withExclusiveMaximum(Boolean exclusiveMaximum)`
`SchemaObjectBuilder`	`withExclusiveMinimum(Boolean exclusiveMinimum)`
`SchemaObjectBuilder`	`withExternalDocs(ExternalDocumentationObject externalDocs)`
`SchemaObjectBuilder`	`withFormat(String format)`
`SchemaObjectBuilder`	`withItems(SchemaObject items)`
`SchemaObjectBuilder`	`withMaximum(Double maximum)`
`SchemaObjectBuilder`	`withMaxItems(Integer maxItems)`
`SchemaObjectBuilder`	`withMaxLength(Integer maxLength)`
`SchemaObjectBuilder`	`withMaxProperties(Integer maxProperties)`
`SchemaObjectBuilder`	`withMinimum(Double minimum)`
`SchemaObjectBuilder`	`withMinItems(Integer minItems)`
`SchemaObjectBuilder`	`withMinLength(Integer minLength)`
`SchemaObjectBuilder`	`withMinProperties(Integer minProperties)`
`SchemaObjectBuilder`	`withMultipleOf(Double multipleOf)`
`SchemaObjectBuilder`	`withNot(List<SchemaObject> not)`
`SchemaObjectBuilder`	`withNullable(Boolean nullable)`
`SchemaObjectBuilder`	`withOneOf(List<SchemaObject> oneOf)`
`SchemaObjectBuilder`	`withPattern(Pattern pattern)`
`SchemaObjectBuilder`	`withProperties(Map<String,SchemaObject> properties)`
`SchemaObjectBuilder`	`withReadOnly(Boolean readOnly)`
`SchemaObjectBuilder`	`withRequired(List<String> required)`
`SchemaObjectBuilder`	`withTitle(String title)`
`SchemaObjectBuilder`	`withType(String type)`
`SchemaObjectBuilder`	`withUniqueItems(Boolean uniqueItems)`
`SchemaObjectBuilder`	`withWriteOnly(Boolean writeOnly)`
`SchemaObjectBuilder`	`withXml(XmlObject xml)`

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

- Constructor Detail
  - SchemaObjectBuilder
```
public SchemaObjectBuilder()
```
- Method Detail
  - withTitle
```
public SchemaObjectBuilder withTitle(String title)
```
  - withMultipleOf
```
public SchemaObjectBuilder withMultipleOf(Double multipleOf)
```
  - withMaximum
```
public SchemaObjectBuilder withMaximum(Double maximum)
```
  - withExclusiveMaximum
```
public SchemaObjectBuilder withExclusiveMaximum(Boolean exclusiveMaximum)
```
  - withMinimum
```
public SchemaObjectBuilder withMinimum(Double minimum)
```
  - withExclusiveMinimum
```
public SchemaObjectBuilder withExclusiveMinimum(Boolean exclusiveMinimum)
```
  - withMaxLength
```
public SchemaObjectBuilder withMaxLength(Integer maxLength)
```
  - withMinLength
```
public SchemaObjectBuilder withMinLength(Integer minLength)
```
  - withPattern
```
public SchemaObjectBuilder withPattern(Pattern pattern)
```
  - withMaxItems
```
public SchemaObjectBuilder withMaxItems(Integer maxItems)
```
  - withMinItems
```
public SchemaObjectBuilder withMinItems(Integer minItems)
```
  - withUniqueItems
```
public SchemaObjectBuilder withUniqueItems(Boolean uniqueItems)
```
  - withMaxProperties
```
public SchemaObjectBuilder withMaxProperties(Integer maxProperties)
```
  - withMinProperties
```
public SchemaObjectBuilder withMinProperties(Integer minProperties)
```
  - withRequired
```
public SchemaObjectBuilder withRequired(List<String> required)
```
  - withEnumValue
```
public SchemaObjectBuilder withEnumValue(List<Object> enumValue)
```
  - withType
```
public SchemaObjectBuilder withType(String type)
```
  - withAllOf
```
public SchemaObjectBuilder withAllOf(List<SchemaObject> allOf)
```
  - withOneOf
```
public SchemaObjectBuilder withOneOf(List<SchemaObject> oneOf)
```
  - withAnyOf
```
public SchemaObjectBuilder withAnyOf(List<SchemaObject> anyOf)
```
  - withNot
```
public SchemaObjectBuilder withNot(List<SchemaObject> not)
```
  - withItems
```
public SchemaObjectBuilder withItems(SchemaObject items)
```
  - withProperties
```
public SchemaObjectBuilder withProperties(Map<String,SchemaObject> properties)
```
  - withAdditionalProperties
```
public SchemaObjectBuilder withAdditionalProperties(Object additionalProperties)
```
  - withDescription
```
public SchemaObjectBuilder withDescription(String description)
```
  - withFormat
```
public SchemaObjectBuilder withFormat(String format)
```
  - withDefaultValue
```
public SchemaObjectBuilder withDefaultValue(Object defaultValue)
```
  - withNullable
```
public SchemaObjectBuilder withNullable(Boolean nullable)
```
    Parameters:
    
    nullable - Allows sending a null value for the defined schema. Default value is false.
    
    Returns:
    
    The current builder
  - withDiscriminator
```
public SchemaObjectBuilder withDiscriminator(DiscriminatorObject discriminator)
```
    Parameters:
    
    discriminator - Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description.
    
    Returns:
    
    The current builder
  - withReadOnly
```
public SchemaObjectBuilder withReadOnly(Boolean readOnly)
```
    Parameters:
    
    readOnly - Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.
    
    Returns:
    
    The current builder
  - withWriteOnly
```
public SchemaObjectBuilder withWriteOnly(Boolean writeOnly)
```
    Parameters:
    
    writeOnly - Relevant only for Schema "properties" definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.
    
    Returns:
    
    The current builder
  - withXml
```
public SchemaObjectBuilder withXml(XmlObject xml)
```
    Parameters:
    
    xml - This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.
    
    Returns:
    
    The current builder
  - withExternalDocs
```
public SchemaObjectBuilder withExternalDocs(ExternalDocumentationObject externalDocs)
```
    Parameters:
    
    externalDocs - Additional external documentation for this schema.
    
    Returns:
    
    The current builder
  - withExample
```
public SchemaObjectBuilder withExample(Object example)
```
    Parameters:
    
    example - A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
    
    Returns:
    
    The current builder
  - withDeprecated
```
public SchemaObjectBuilder withDeprecated(Boolean deprecated)
```
    Parameters:
    
    deprecated - Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is false.
    
    Returns:
    
    The current builder
  - build
```
public SchemaObject build()
```
  - schemaObject
```
public static SchemaObjectBuilder schemaObject()
```
    Creates a builder for a SchemaObject
    
    Returns:
    
    A new builder
  - schemaObjectFrom
```
public static SchemaObjectBuilder schemaObjectFrom(Class<?> from)
```
    Creates a builder for a SchemaObject with the type and format based on the given class
    
    Parameters:
    
    from - Type type to build from, e.g. if the type is String.class then the type will be set as string.
    
    Returns:
    
    A new builder

Class SchemaObjectBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SchemaObjectBuilder

Method Detail

withTitle

withMultipleOf

withMaximum

withExclusiveMaximum

withMinimum

withExclusiveMinimum

withMaxLength

withMinLength

withPattern

withMaxItems

withMinItems

withUniqueItems

withMaxProperties

withMinProperties

withRequired

withEnumValue

withType

withAllOf

withOneOf

withAnyOf

withNot

withItems

withProperties

withAdditionalProperties

withDescription

withFormat

withDefaultValue

withNullable

withDiscriminator

withReadOnly

withWriteOnly

withXml

withExternalDocs

withExample

withDeprecated

build

schemaObject

schemaObjectFrom