Package io.muserver.openapi

Class SchemaObject

java.lang.Object

io.muserver.openapi.SchemaObject

public class SchemaObject
extends java.lang.Object

See Also:

SchemaObjectBuilder

Method Summary

Modifier and Type	Method	Description
java.lang.Object	additionalProperties()
java.util.List<SchemaObject>	allOf()
java.util.List<SchemaObject>	anyOf()
java.lang.Object	defaultValue()
java.lang.Boolean	deprecated()
java.lang.String	description()
DiscriminatorObject	discriminator()
java.util.List<java.lang.Object>	enumValue()
java.lang.Object	example()
java.lang.Boolean	exclusiveMaximum()
java.lang.Boolean	exclusiveMinimum()
ExternalDocumentationObject	externalDocs()
java.lang.String	format()
boolean	isDeprecated()
SchemaObject	items()
java.lang.Double	maximum()
java.lang.Integer	maxItems()
java.lang.Integer	maxLength()
java.lang.Integer	maxProperties()
java.lang.Double	minimum()
java.lang.Integer	minItems()
java.lang.Integer	minLength()
java.lang.Integer	minProperties()
java.lang.Double	multipleOf()
java.util.List<SchemaObject>	not()
java.lang.Boolean	nullable()
java.util.List<SchemaObject>	oneOf()
java.util.regex.Pattern	pattern()
java.util.Map<java.lang.String,SchemaObject>	properties()
java.lang.Boolean	readOnly()
java.util.List<java.lang.String>	required()
java.lang.String	title()
SchemaObjectBuilder	toBuilder()
java.lang.String	toString()
java.lang.String	type()
java.lang.Boolean	uniqueItems()
void	writeJson(java.io.Writer writer)
java.lang.Boolean	writeOnly()
XmlObject	xml()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

writeJson

public void writeJson(java.io.Writer writer)
               throws java.io.IOException

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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 java.lang.String title()

Returns:

the value described by SchemaObjectBuilder.withTitle(java.lang.String)

multipleOf

public java.lang.Double multipleOf()

Returns:

the value described by SchemaObjectBuilder.withMultipleOf(java.lang.Double)

maximum

public java.lang.Double maximum()

Returns:

the value described by SchemaObjectBuilder.withMaximum(java.lang.Double)

exclusiveMaximum

public java.lang.Boolean exclusiveMaximum()

Returns:

the value described by SchemaObjectBuilder.withExclusiveMaximum(java.lang.Boolean)

minimum

public java.lang.Double minimum()

Returns:

the value described by SchemaObjectBuilder.withMinimum(java.lang.Double)

exclusiveMinimum

public java.lang.Boolean exclusiveMinimum()

Returns:

the value described by SchemaObjectBuilder.withExclusiveMinimum(java.lang.Boolean)

maxLength

public java.lang.Integer maxLength()

Returns:

the value described by SchemaObjectBuilder.withMaxLength(java.lang.Integer)

minLength

public java.lang.Integer minLength()

Returns:

the value described by SchemaObjectBuilder.withMinLength(java.lang.Integer)

pattern

public java.util.regex.Pattern pattern()

Returns:

the value described by SchemaObjectBuilder.withPattern(java.util.regex.Pattern)

maxItems

public java.lang.Integer maxItems()

Returns:

the value described by SchemaObjectBuilder.withMaxItems(java.lang.Integer)

minItems

public java.lang.Integer minItems()

Returns:

the value described by SchemaObjectBuilder.withMinItems(java.lang.Integer)

uniqueItems

public java.lang.Boolean uniqueItems()

Returns:

the value described by SchemaObjectBuilder.withUniqueItems(java.lang.Boolean)

maxProperties

public java.lang.Integer maxProperties()

Returns:

the value described by SchemaObjectBuilder.withMaxProperties(java.lang.Integer)

minProperties

public java.lang.Integer minProperties()

Returns:

the value described by SchemaObjectBuilder.withMinProperties(java.lang.Integer)

required

public java.util.List<java.lang.String> required()

Returns:

the value described by SchemaObjectBuilder.withRequired(java.util.List<java.lang.String>)

enumValue

public java.util.List<java.lang.Object> enumValue()

Returns:

the value described by SchemaObjectBuilder.withEnumValue(java.util.List<java.lang.Object>)

type

public java.lang.String type()

Returns:

the value described by SchemaObjectBuilder.withType(java.lang.String)

allOf

public java.util.List<SchemaObject> allOf()

Returns:

the value described by SchemaObjectBuilder.withAllOf(java.util.List<io.muserver.openapi.SchemaObject>)

oneOf

public java.util.List<SchemaObject> oneOf()

Returns:

the value described by SchemaObjectBuilder.withOneOf(java.util.List<io.muserver.openapi.SchemaObject>)

anyOf

public java.util.List<SchemaObject> anyOf()

Returns:

the value described by SchemaObjectBuilder.withAnyOf(java.util.List<io.muserver.openapi.SchemaObject>)

not

public java.util.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 java.util.Map<java.lang.String,SchemaObject> properties()

Returns:

the value described by SchemaObjectBuilder.withProperties(java.util.Map<java.lang.String, io.muserver.openapi.SchemaObject>)

additionalProperties

public java.lang.Object additionalProperties()

Returns:

the value described by SchemaObjectBuilder.withAdditionalProperties(java.lang.Object)

description

public java.lang.String description()

Returns:

the value described by SchemaObjectBuilder.withDescription(java.lang.String)

format

public java.lang.String format()

Returns:

the value described by SchemaObjectBuilder.withFormat(java.lang.String)

defaultValue

public java.lang.Object defaultValue()

Returns:

the value described by SchemaObjectBuilder.withDefaultValue(java.lang.Object)

nullable

public java.lang.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 java.lang.Boolean readOnly()

Returns:

the value described by SchemaObjectBuilder.withReadOnly(java.lang.Boolean)

writeOnly

public java.lang.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 java.lang.Object example()

Returns:

the value described by SchemaObjectBuilder.withExample(java.lang.Object)

deprecated

public java.lang.Boolean deprecated()

Returns:

the value described by SchemaObjectBuilder.withDeprecated(java.lang.Boolean)