Package org.apache.juneau.httppart

Class HttpPartSchema

java.lang.Object

org.apache.juneau.httppart.HttpPartSchema

public class HttpPartSchema
extends Object

Represents an OpenAPI schema definition.

The schema definition can be applied to any HTTP parts such as bodies, headers, query/form parameters, and URL path parts.
The API is generic enough to apply to any path part although some attributes may only applicable for certain parts.

Schema objects are created via builders instantiated through the create() method.

Notes:

• This class is thread safe and reusable.

See Also:

• OpenAPI Details

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpPartSchema.Builder	Builder class.

Field Summary

Fields

Modifier and Type	Field	Description
static final HttpPartSchema	DEFAULT	Reusable instance of this object, all default settings.
static final HttpPartSchema	T_ARRAY	Array type
static final HttpPartSchema	T_ARRAY_CSV	Comma-delimited array type
static final HttpPartSchema	T_ARRAY_MULTI	Multi-part array type
static final HttpPartSchema	T_ARRAY_PIPES	Pipe-delimited array type
static final HttpPartSchema	T_ARRAY_SSV	Space-delimited array type
static final HttpPartSchema	T_ARRAY_TSV	Tab-delimited array type
static final HttpPartSchema	T_ARRAY_UON	UON-formatted array type
static final HttpPartSchema	T_BINARY	Binary type
static final HttpPartSchema	T_BINARY_SPACED	Spaced binary type
static final HttpPartSchema	T_BOOLEAN	Boolean type
static final HttpPartSchema	T_BYTE	Byte type
static final HttpPartSchema	T_DATE	Date type
static final HttpPartSchema	T_DATETIME	Date-time type
static final HttpPartSchema	T_DOUBLE	Double type
static final HttpPartSchema	T_FILE	File type
static final HttpPartSchema	T_FLOAT	Float type
static final HttpPartSchema	T_INT32	Int32 type
static final HttpPartSchema	T_INT64	Int64 type
static final HttpPartSchema	T_INTEGER	Integer type
static final HttpPartSchema	T_NONE	No type
static final HttpPartSchema	T_NUMBER	Number type
static final HttpPartSchema	T_OBJECT	Object type
static final HttpPartSchema	T_OBJECT_CSV	Comma-delimited object type
static final HttpPartSchema	T_OBJECT_PIPES	Pipe-delimited object type
static final HttpPartSchema	T_OBJECT_SSV	Space-delimited object type
static final HttpPartSchema	T_OBJECT_TSV	Tab-delimited object type
static final HttpPartSchema	T_OBJECT_UON	UON-formated object type
static final HttpPartSchema	T_STRING	String type
static final HttpPartSchema	T_UON	UON-formated simple type

Method Summary

Modifier and Type	Method	Description
static HttpPartSchema.Builder	create()	Instantiates a new builder for this object.
static HttpPartSchema	create(Annotation a)	Finds the schema information on the specified annotation.
static HttpPartSchema	create(Annotation a, String defaultName)	Finds the schema information on the specified annotation.
static HttpPartSchema	create(Class<? extends Annotation> c, Method m)	Finds the schema information for the specified method return.
static HttpPartSchema	create(Class<? extends Annotation> c, Type t)	Finds the schema information for the specified class.
static HttpPartSchema	create(Class<? extends Annotation> c, ParamInfo mpi)	Finds the schema information for the specified method parameter.
static HttpPartSchema.Builder	create(String type)	Shortcut for calling create().type(type);
static HttpPartSchema.Builder	create(String type, String format)	Shortcut for calling create().type(type).format(format);
HttpPartCollectionFormat	getCollectionFormat()	Returns the collectionFormat field of this schema.
String	getDefault()	Returns the default field of this schema.
Set<String>	getEnum()	Returns the enum field of this schema.
HttpPartFormat	getFormat()	Returns the format field of this schema.
HttpPartFormat	getFormat(ClassMeta<?> cm)	Returns the format field of this schema.
HttpPartSchema	getItems()	Returns the maximum field of this schema.
Number	getMaximum()	Returns the maximum field of this schema.
Long	getMaxItems()	Returns the xxx field of this schema.
Long	getMaxLength()	Returns the xxx field of this schema.
Long	getMaxProperties()	Returns the xxx field of this schema.
Number	getMinimum()	Returns the minimum field of this schema.
Long	getMinItems()	Returns the xxx field of this schema.
Long	getMinLength()	Returns the xxx field of this schema.
Long	getMinProperties()	Returns the xxx field of this schema.
Number	getMultipleOf()	Returns the xxx field of this schema.
String	getName()	Returns the name of the object described by this schema, for example the query or form parameter name.
ClassMeta<?>	getParsedType()	Returns the default parsed type for this schema.
Class<? extends HttpPartParser>	getParser()	Returns the parser field of this schema.
Pattern	getPattern()	Returns the xxx field of this schema.
HttpPartSchema	getProperty(String name)	Returns the schema information for the specified property.
Class<? extends HttpPartSerializer>	getSerializer()	Returns the serializer field of this schema.
HttpPartDataType	getType()	Returns the type field of this schema.
HttpPartDataType	getType(ClassMeta<?> cm)	Returns the type field of this schema.
boolean	hasProperties()	Returns true if this schema has properties associated with it.
boolean	isAllowEmptyValue()	Returns the allowEmptyValue field of this schema.
boolean	isExclusiveMaximum()	Returns the exclusiveMaximum field of this schema.
boolean	isExclusiveMinimum()	Returns the exclusiveMinimum field of this schema.
boolean	isRequired()	Returns the required field of this schema.
boolean	isSkipIfEmpty()	Returns the skipIfEmpty field of this schema.
boolean	isUniqueItems()	Returns the uniqueItems field of this schema.
static HttpPartSchema.Builder	tArray()	Shortcut for create().type(HttpPartDataType.ARRAY).
static HttpPartSchema.Builder	tArray(HttpPartSchema.Builder items)	Shortcut for create().type(HttpPartDataType.ARRAY).items(items).
static HttpPartSchema.Builder	tArrayCsv()	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.CSV).
static HttpPartSchema.Builder	tArrayCsv(HttpPartSchema.Builder items)	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.CSV).items(items).
static HttpPartSchema.Builder	tArrayMulti()	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.MULTI).
static HttpPartSchema.Builder	tArrayMulti(HttpPartSchema.Builder items)	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.MULTI).items(items).
static HttpPartSchema.Builder	tArrayPipes()	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.PIPES).
static HttpPartSchema.Builder	tArrayPipes(HttpPartSchema.Builder items)	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.PIPES).items(items).
static HttpPartSchema.Builder	tArraySsv()	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.SSV).
static HttpPartSchema.Builder	tArraySsv(HttpPartSchema.Builder items)	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.SSV).items(items).
static HttpPartSchema.Builder	tArrayTsv()	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.TSV).
static HttpPartSchema.Builder	tArrayTsv(HttpPartSchema.Builder items)	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.TSV).items(items).
static HttpPartSchema.Builder	tArrayUon()	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.UONC).
static HttpPartSchema.Builder	tArrayUon(HttpPartSchema.Builder items)	Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.UONC).items(items).
static HttpPartSchema.Builder	tBinary()	Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.BINARY).
static HttpPartSchema.Builder	tBinarySpaced()	Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.BINARY_SPACED).
static HttpPartSchema.Builder	tBoolean()	Shortcut for create().type(HttpPartDataType.BOOLEAN).
static HttpPartSchema.Builder	tByte()	Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.BYTE).
static HttpPartSchema.Builder	tDate()	Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.DATE).
static HttpPartSchema.Builder	tDateTime()	Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.DATE_TIME).
static HttpPartSchema.Builder	tDouble()	Shortcut for create().type(HttpPartDataType.NUMBER).format(HttpPartFormat.DOUBLE).
static HttpPartSchema.Builder	tFile()	Shortcut for create().type(HttpPartDataType.FILE).
static HttpPartSchema.Builder	tFloat()	Shortcut for create().type(HttpPartDataType.NUMBER).format(HttpPartFormat.FLOAT).
static HttpPartSchema.Builder	tInt32()	Shortcut for create().type(HttpPartDataType.INTEGER).format(HttpPartFormat.INT32).
static HttpPartSchema.Builder	tInt64()	Shortcut for create().type(HttpPartDataType.INTEGER).format(HttpPartFormat.INT64).
static HttpPartSchema.Builder	tInteger()	Shortcut for create().type(HttpPartDataType.INTEGER).
static HttpPartSchema.Builder	tNone()	Shortcut for create().type(HttpPartDataType.NONE).
static HttpPartSchema.Builder	tNumber()	Shortcut for create().type(HttpPartDataType.NUMBER).
static HttpPartSchema.Builder	tObject()	Shortcut for create().type(HttpPartDataType.OBJECT).
static HttpPartSchema.Builder	tObjectCsv()	Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.CSV).
static HttpPartSchema.Builder	tObjectPipes()	Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.PIPES).
static HttpPartSchema.Builder	tObjectSsv()	Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.SSV).
static HttpPartSchema.Builder	tObjectTsv()	Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.TSV).
static HttpPartSchema.Builder	tObjectUon()	Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.UON).
String	toString()
static HttpPartSchema.Builder	tString()	Shortcut for create().type(HttpPartDataType.STRING).
static HttpPartSchema.Builder	tUon()	Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.UON).
String	validateInput(String in)	Throws a ParseException if the specified pre-parsed input does not validate against this schema.
<T> T	validateOutput(T o, BeanContext bc)	Throws a ParseException if the specified parsed output does not validate against this schema.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final HttpPartSchema DEFAULT

Reusable instance of this object, all default settings.

T_BOOLEAN

public static final HttpPartSchema T_BOOLEAN

Boolean type

T_FILE

public static final HttpPartSchema T_FILE

File type

T_INTEGER

public static final HttpPartSchema T_INTEGER

Integer type

T_INT32

public static final HttpPartSchema T_INT32

Int32 type

T_INT64

public static final HttpPartSchema T_INT64

Int64 type

T_NONE

public static final HttpPartSchema T_NONE

No type

T_NUMBER

public static final HttpPartSchema T_NUMBER

Number type

T_FLOAT

public static final HttpPartSchema T_FLOAT

Float type

T_DOUBLE

public static final HttpPartSchema T_DOUBLE

Double type

T_STRING

public static final HttpPartSchema T_STRING

String type

T_BYTE

public static final HttpPartSchema T_BYTE

Byte type

T_BINARY

public static final HttpPartSchema T_BINARY

Binary type

T_BINARY_SPACED

public static final HttpPartSchema T_BINARY_SPACED

Spaced binary type

T_DATE

public static final HttpPartSchema T_DATE

Date type

T_DATETIME

public static final HttpPartSchema T_DATETIME

Date-time type

T_UON

public static final HttpPartSchema T_UON

UON-formated simple type

T_ARRAY

public static final HttpPartSchema T_ARRAY

Array type

T_ARRAY_CSV

public static final HttpPartSchema T_ARRAY_CSV

Comma-delimited array type

T_ARRAY_PIPES

public static final HttpPartSchema T_ARRAY_PIPES

Pipe-delimited array type

T_ARRAY_SSV

public static final HttpPartSchema T_ARRAY_SSV

Space-delimited array type

T_ARRAY_TSV

public static final HttpPartSchema T_ARRAY_TSV

Tab-delimited array type

T_ARRAY_UON

public static final HttpPartSchema T_ARRAY_UON

UON-formatted array type

T_ARRAY_MULTI

public static final HttpPartSchema T_ARRAY_MULTI

Multi-part array type

T_OBJECT

public static final HttpPartSchema T_OBJECT

Object type

T_OBJECT_CSV

public static final HttpPartSchema T_OBJECT_CSV

Comma-delimited object type

T_OBJECT_PIPES

public static final HttpPartSchema T_OBJECT_PIPES

Pipe-delimited object type

T_OBJECT_SSV

public static final HttpPartSchema T_OBJECT_SSV

Space-delimited object type

T_OBJECT_TSV

public static final HttpPartSchema T_OBJECT_TSV

Tab-delimited object type

T_OBJECT_UON

public static final HttpPartSchema T_OBJECT_UON

UON-formated object type

Method Details

create

public static HttpPartSchema.Builder create()

Instantiates a new builder for this object.

Returns:

A new builder for this object.

tBoolean

public static HttpPartSchema.Builder tBoolean()

Shortcut for create().type(HttpPartDataType.BOOLEAN).

Returns:

A new builder for this object.

tFile

public static HttpPartSchema.Builder tFile()

Shortcut for create().type(HttpPartDataType.FILE).

Returns:

A new builder for this object.

tInteger

public static HttpPartSchema.Builder tInteger()

Shortcut for create().type(HttpPartDataType.INTEGER).

Returns:

A new builder for this object.

tInt32

public static HttpPartSchema.Builder tInt32()

Shortcut for create().type(HttpPartDataType.INTEGER).format(HttpPartFormat.INT32).

Returns:

A new builder for this object.

tInt64

public static HttpPartSchema.Builder tInt64()

Shortcut for create().type(HttpPartDataType.INTEGER).format(HttpPartFormat.INT64).

Returns:

A new builder for this object.

tNone

public static HttpPartSchema.Builder tNone()

Shortcut for create().type(HttpPartDataType.NONE).

Returns:

A new builder for this object.

tNumber

public static HttpPartSchema.Builder tNumber()

Shortcut for create().type(HttpPartDataType.NUMBER).

Returns:

A new builder for this object.

tFloat

public static HttpPartSchema.Builder tFloat()

Shortcut for create().type(HttpPartDataType.NUMBER).format(HttpPartFormat.FLOAT).

Returns:

A new builder for this object.

tDouble

public static HttpPartSchema.Builder tDouble()

Shortcut for create().type(HttpPartDataType.NUMBER).format(HttpPartFormat.DOUBLE).

Returns:

A new builder for this object.

tString

public static HttpPartSchema.Builder tString()

Shortcut for create().type(HttpPartDataType.STRING).

Returns:

A new builder for this object.

tByte

public static HttpPartSchema.Builder tByte()

Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.BYTE).

Returns:

A new builder for this object.

tBinary

public static HttpPartSchema.Builder tBinary()

Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.BINARY).

Returns:

A new builder for this object.

tBinarySpaced

public static HttpPartSchema.Builder tBinarySpaced()

Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.BINARY_SPACED).

Returns:

A new builder for this object.

tDate

public static HttpPartSchema.Builder tDate()

Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.DATE).

Returns:

A new builder for this object.

tDateTime

public static HttpPartSchema.Builder tDateTime()

Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.DATE_TIME).

Returns:

A new builder for this object.

tUon

public static HttpPartSchema.Builder tUon()

Shortcut for create().type(HttpPartDataType.STRING).format(HttpPartFormat.UON).

Returns:

A new builder for this object.

tArray

public static HttpPartSchema.Builder tArray()

Shortcut for create().type(HttpPartDataType.ARRAY).

Returns:

A new builder for this object.

tArray

public static HttpPartSchema.Builder tArray(HttpPartSchema.Builder items)

Shortcut for create().type(HttpPartDataType.ARRAY).items(items).

Parameters:

items - The schema of the array items.

Returns:

A new builder for this object.

tArrayCsv

public static HttpPartSchema.Builder tArrayCsv()

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.CSV).

Returns:

A new builder for this object.

tArrayCsv

public static HttpPartSchema.Builder tArrayCsv(HttpPartSchema.Builder items)

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.CSV).items(items).

Parameters:

items - The schema of the array items.

Returns:

A new builder for this object.

tArrayPipes

public static HttpPartSchema.Builder tArrayPipes()

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.PIPES).

Returns:

A new builder for this object.

tArrayPipes

public static HttpPartSchema.Builder tArrayPipes(HttpPartSchema.Builder items)

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.PIPES).items(items).

Parameters:

items - The schema of the array items.

Returns:

A new builder for this object.

tArraySsv

public static HttpPartSchema.Builder tArraySsv()

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.SSV).

Returns:

A new builder for this object.

tArraySsv

public static HttpPartSchema.Builder tArraySsv(HttpPartSchema.Builder items)

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.SSV).items(items).

Parameters:

items - The schema of the array items.

Returns:

A new builder for this object.

tArrayTsv

public static HttpPartSchema.Builder tArrayTsv()

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.TSV).

Returns:

A new builder for this object.

tArrayTsv

public static HttpPartSchema.Builder tArrayTsv(HttpPartSchema.Builder items)

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.TSV).items(items).

Parameters:

items - The schema of the array items.

Returns:

A new builder for this object.

tArrayUon

public static HttpPartSchema.Builder tArrayUon()

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.UONC).

Returns:

A new builder for this object.

tArrayUon

public static HttpPartSchema.Builder tArrayUon(HttpPartSchema.Builder items)

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.UONC).items(items).

Parameters:

items - The schema of the array items.

Returns:

A new builder for this object.

tArrayMulti

public static HttpPartSchema.Builder tArrayMulti()

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.MULTI).

Returns:

A new builder for this object.

tArrayMulti

public static HttpPartSchema.Builder tArrayMulti(HttpPartSchema.Builder items)

Shortcut for create().type(HttpPartDataType.ARRAY).collectionFormat(HttpPartCollectionFormat.MULTI).items(items).

Parameters:

items - The schema of the array items.

Returns:

A new builder for this object.

tObject

public static HttpPartSchema.Builder tObject()

Shortcut for create().type(HttpPartDataType.OBJECT).

Returns:

A new builder for this object.

tObjectCsv

public static HttpPartSchema.Builder tObjectCsv()

Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.CSV).

Returns:

A new builder for this object.

tObjectPipes

public static HttpPartSchema.Builder tObjectPipes()

Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.PIPES).

Returns:

A new builder for this object.

tObjectSsv

public static HttpPartSchema.Builder tObjectSsv()

Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.SSV).

Returns:

A new builder for this object.

tObjectTsv

public static HttpPartSchema.Builder tObjectTsv()

Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.TSV).

Returns:

A new builder for this object.

tObjectUon

public static HttpPartSchema.Builder tObjectUon()

Shortcut for create().type(HttpPartDataType.OBJECT).collectionFormat(HttpPartCollectionFormat.UON).

Returns:

A new builder for this object.

create

public static HttpPartSchema create(Class<? extends Annotation> c,
 ParamInfo mpi)

Finds the schema information for the specified method parameter.

This method will gather all the schema information from the annotations at the following locations:

• The method parameter.
• The method parameter class.
• The method parameter parent classes and interfaces.

Parameters:

c - The annotation to look for.
Valid values:

• Content
• Header
• Query
• FormData
• Path
• Response
• HasQuery
• HasFormData

mpi - The Java method parameter.

Returns:

The schema information about the parameter.

create

public static HttpPartSchema create(Class<? extends Annotation> c,
 Method m)

Finds the schema information for the specified method return.

This method will gather all the schema information from the annotations at the following locations:

• The method.
• The method return class.
• The method return parent classes and interfaces.

Parameters:

c - The annotation to look for.
Valid values:

• Content
• Header
• Query
• FormData
• Path
• Response
• HasQuery
• HasFormData

m - The Java method with the return type being checked.

Returns:

The schema information about the parameter.

create

public static HttpPartSchema create(Class<? extends Annotation> c,
 Type t)

Finds the schema information for the specified class.

This method will gather all the schema information from the annotations on the class and all parent classes/interfaces.

Parameters:

c - The annotation to look for.
Valid values:

• Content
• Header
• Query
• FormData
• Path
• Response
• HasQuery
• HasFormData

t - The class containing the parameter.

Returns:

The schema information about the parameter.

create

public static HttpPartSchema.Builder create(String type)

Shortcut for calling create().type(type);

Parameters:

type - The schema type value.

Returns:

A new builder.

create

public static HttpPartSchema.Builder create(String type,
 String format)

Shortcut for calling create().type(type).format(format);

Parameters:

type - The schema type value.

format - The schema format value.

Returns:

A new builder.

create

public static HttpPartSchema create(Annotation a)

Finds the schema information on the specified annotation.

Parameters:

a - The annotation to find the schema information on..

Returns:

The schema information found on the annotation.

create

public static HttpPartSchema create(Annotation a,
 String defaultName)

Finds the schema information on the specified annotation.

Parameters:

a - The annotation to find the schema information on..

defaultName - The default part name if not specified on the annotation.

Returns:

The schema information found on the annotation.

getParsedType

public ClassMeta<?> getParsedType()

Returns the default parsed type for this schema.

Returns:

The default parsed type for this schema. Never null.

getName

public String getName()

Returns the name of the object described by this schema, for example the query or form parameter name.

Returns:

The name, or null if not specified.

See Also:

• HttpPartSchema.Builder.name(String)

getType

public HttpPartDataType getType()

Returns the type field of this schema.

Returns:

The type field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.type(String)

getType

public HttpPartDataType getType(ClassMeta<?> cm)

Returns the type field of this schema.

Parameters:

cm - The class meta of the object.
Used to auto-detect the type if the type was not specified.

Returns:

The format field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.format(String)

getDefault

public String getDefault()

Returns the default field of this schema.

Returns:

The default value for this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder._default(String)

getCollectionFormat

public HttpPartCollectionFormat getCollectionFormat()

Returns the collectionFormat field of this schema.

Returns:

The collectionFormat field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.collectionFormat(String)

getFormat

public HttpPartFormat getFormat()

Returns the format field of this schema.

Returns:

The format field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.format(String)

getFormat

public HttpPartFormat getFormat(ClassMeta<?> cm)

Returns the format field of this schema.

Parameters:

cm - The class meta of the object.
Used to auto-detect the format if the format was not specified.

Returns:

The format field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.format(String)

getItems

public HttpPartSchema getItems()

Returns the maximum field of this schema.

Returns:

The schema for child items of the object represented by this schema, or null if not defined.

See Also:

• HttpPartSchema.Builder.items(HttpPartSchema.Builder)

getMaximum

public Number getMaximum()

Returns the maximum field of this schema.

Returns:

The maximum field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.maximum(Number)

getMinimum

public Number getMinimum()

Returns the minimum field of this schema.

Returns:

The minimum field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.minimum(Number)

getMultipleOf

public Number getMultipleOf()

Returns the xxx field of this schema.

Returns:

The xxx field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.multipleOf(Number)

getPattern

public Pattern getPattern()

Returns the xxx field of this schema.

Returns:

The xxx field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.pattern(String)

getMaxLength

public Long getMaxLength()

Returns the xxx field of this schema.

Returns:

The xxx field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.maxLength(Long)

getMinLength

public Long getMinLength()

Returns the xxx field of this schema.

Returns:

The xxx field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.minLength(Long)

getMaxItems

public Long getMaxItems()

Returns the xxx field of this schema.

Returns:

The xxx field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.maxItems(Long)

getMinItems

public Long getMinItems()

Returns the xxx field of this schema.

Returns:

The xxx field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.minItems(Long)

getMaxProperties

public Long getMaxProperties()

Returns the xxx field of this schema.

Returns:

The xxx field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.maxProperties(Long)

getMinProperties

public Long getMinProperties()

Returns the xxx field of this schema.

Returns:

The xxx field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.minProperties(Long)

isExclusiveMaximum

public boolean isExclusiveMaximum()

Returns the exclusiveMaximum field of this schema.

Returns:

The exclusiveMaximum field of this schema.

See Also:

• HttpPartSchema.Builder.exclusiveMaximum(Boolean)

isExclusiveMinimum

public boolean isExclusiveMinimum()

Returns the exclusiveMinimum field of this schema.

Returns:

The exclusiveMinimum field of this schema.

See Also:

• HttpPartSchema.Builder.exclusiveMinimum(Boolean)

isUniqueItems

public boolean isUniqueItems()

Returns the uniqueItems field of this schema.

Returns:

The uniqueItems field of this schema.

See Also:

• HttpPartSchema.Builder.uniqueItems(Boolean)

isRequired

public boolean isRequired()

Returns the required field of this schema.

Returns:

The required field of this schema.

See Also:

• HttpPartSchema.Builder.required(Boolean)

isSkipIfEmpty

public boolean isSkipIfEmpty()

Returns the skipIfEmpty field of this schema.

Returns:

The skipIfEmpty field of this schema.

See Also:

• HttpPartSchema.Builder.skipIfEmpty(Boolean)

isAllowEmptyValue

public boolean isAllowEmptyValue()

Returns the allowEmptyValue field of this schema.

Returns:

The skipIfEmpty field of this schema.

See Also:

• HttpPartSchema.Builder.skipIfEmpty(Boolean)

getEnum

public Set<String> getEnum()

Returns the enum field of this schema.

Returns:

The enum field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder._enum(Set)

getParser

public Class<? extends HttpPartParser> getParser()

Returns the parser field of this schema.

Returns:

The parser field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.parser(Class)

getSerializer

public Class<? extends HttpPartSerializer> getSerializer()

Returns the serializer field of this schema.

Returns:

The serializer field of this schema, or null if not specified.

See Also:

• HttpPartSchema.Builder.serializer(Class)

validateInput

public String validateInput(String in)
                     throws SchemaValidationException

Throws a ParseException if the specified pre-parsed input does not validate against this schema.

Parameters:

in - The input.

Returns:

The same object passed in.

Throws:

SchemaValidationException - if the specified pre-parsed input does not validate against this schema.

validateOutput

public <T> T validateOutput(T o,
 BeanContext bc)
                     throws SchemaValidationException

Throws a ParseException if the specified parsed output does not validate against this schema.

Type Parameters:

T - The return type.

Parameters:

o - The parsed output.

bc - The bean context used to detect POJO types.

Returns:

The same object passed in.

Throws:

SchemaValidationException - if the specified parsed output does not validate against this schema.

getProperty

public HttpPartSchema getProperty(String name)

Returns the schema information for the specified property.

Parameters:

name - The property name.

Returns:

The schema information for the specified property, or null if properties are not defined on this schema.

hasProperties

public boolean hasProperties()

Returns true if this schema has properties associated with it.

Returns:

true if this schema has properties associated with it.

toString

public String toString()

Overrides:

toString in class Object