Package org.apache.juneau.annotation

Class SchemaAnnotation.Builder

java.lang.Object

org.apache.juneau.annotation.AnnotationBuilder

org.apache.juneau.annotation.TargetedAnnotationBuilder

org.apache.juneau.annotation.TargetedAnnotationTBuilder

org.apache.juneau.annotation.TargetedAnnotationTMFBuilder

org.apache.juneau.annotation.SchemaAnnotation.Builder

Enclosing class:

SchemaAnnotation

public static class SchemaAnnotation.Builder
extends TargetedAnnotationTMFBuilder

Builder class.

See Also:

• BeanContext.Builder.annotations(Annotation...)

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor.

Method Summary

Modifier and Type	Method	Description
SchemaAnnotation.Builder	_default(String... value)	Sets the Schema._default() property on this annotation.
SchemaAnnotation.Builder	_enum(String... value)	Sets the Schema._enum() property on this annotation.
SchemaAnnotation.Builder	$ref(String value)	Sets the Schema.$ref() property on this annotation.
SchemaAnnotation.Builder	additionalProperties(String... value)	Sets the Schema.additionalProperties() property on this annotation.
SchemaAnnotation.Builder	aev(boolean value)	Sets the Schema.aev() property on this annotation.
SchemaAnnotation.Builder	allOf(String... value)	Sets the Schema.allOf() property on this annotation.
SchemaAnnotation.Builder	allowEmptyValue(boolean value)	Sets the Schema.allowEmptyValue() property on this annotation.
Schema	build()	Instantiates a new @Schema object initialized with this builder.
SchemaAnnotation.Builder	cf(String value)	Sets the Schema.cf() property on this annotation.
SchemaAnnotation.Builder	collectionFormat(String value)	Sets the Schema.collectionFormat() property on this annotation.
SchemaAnnotation.Builder	d(String... value)	Sets the Schema.d() property on this annotation.
SchemaAnnotation.Builder	description(String... value)	Sets the Schema.description() property on this annotation.
SchemaAnnotation.Builder	df(String... value)	Sets the Schema.df() property on this annotation.
SchemaAnnotation.Builder	discriminator(String value)	Sets the Schema.discriminator() property on this annotation.
SchemaAnnotation.Builder	e(String... value)	Sets the Schema.e() property on this annotation.
SchemaAnnotation.Builder	emax(boolean value)	Sets the Schema.emax() property on this annotation.
SchemaAnnotation.Builder	emin(boolean value)	Sets the Schema.emin() property on this annotation.
SchemaAnnotation.Builder	exclusiveMaximum(boolean value)	Sets the Schema.exclusiveMaximum() property on this annotation.
SchemaAnnotation.Builder	exclusiveMinimum(boolean value)	Sets the Schema.exclusiveMinimum() property on this annotation.
SchemaAnnotation.Builder	externalDocs(ExternalDocs value)	Sets the Schema.externalDocs() property on this annotation.
SchemaAnnotation.Builder	f(String value)	Sets the Schema.f() property on this annotation.
SchemaAnnotation.Builder	format(String value)	Sets the Schema.format() property on this annotation.
SchemaAnnotation.Builder	ignore(boolean value)	Sets the Schema.ignore() property on this annotation.
SchemaAnnotation.Builder	items(Items value)	Sets the Schema.items() property on this annotation.
SchemaAnnotation.Builder	max(String value)	Sets the Schema.max() property on this annotation.
SchemaAnnotation.Builder	maxi(long value)	Sets the Schema.maxi() property on this annotation.
SchemaAnnotation.Builder	maximum(String value)	Sets the Schema.maximum() property on this annotation.
SchemaAnnotation.Builder	maxItems(long value)	Sets the Schema.maxItems() property on this annotation.
SchemaAnnotation.Builder	maxl(long value)	Sets the Schema.maxl() property on this annotation.
SchemaAnnotation.Builder	maxLength(long value)	Sets the Schema.maxLength() property on this annotation.
SchemaAnnotation.Builder	maxp(long value)	Sets the Schema.maxp() property on this annotation.
SchemaAnnotation.Builder	maxProperties(long value)	Sets the Schema.maxProperties() property on this annotation.
SchemaAnnotation.Builder	min(String value)	Sets the Schema.min() property on this annotation.
SchemaAnnotation.Builder	mini(long value)	Sets the Schema.mini() property on this annotation.
SchemaAnnotation.Builder	minimum(String value)	Sets the Schema.minimum() property on this annotation.
SchemaAnnotation.Builder	minItems(long value)	Sets the Schema.minItems() property on this annotation.
SchemaAnnotation.Builder	minl(long value)	Sets the Schema.minl() property on this annotation.
SchemaAnnotation.Builder	minLength(long value)	Sets the Schema.minLength() property on this annotation.
SchemaAnnotation.Builder	minp(long value)	Sets the Schema.minp() property on this annotation.
SchemaAnnotation.Builder	minProperties(long value)	Sets the Schema.minProperties() property on this annotation.
SchemaAnnotation.Builder	mo(String value)	Sets the Schema.mo() property on this annotation.
SchemaAnnotation.Builder	multipleOf(String value)	Sets the Schema.multipleOf() property on this annotation.
SchemaAnnotation.Builder	on(Class<?>... value)	Appends the classes that this annotation applies to.
SchemaAnnotation.Builder	on(Field... value)	Appends the fields that this annotation applies to.
SchemaAnnotation.Builder	on(Method... value)	Appends the methods that this annotation applies to.
SchemaAnnotation.Builder	on(String... values)	The targets this annotation applies to.
SchemaAnnotation.Builder	onClass(Class<?>... value)	Appends the classes that this annotation applies to.
SchemaAnnotation.Builder	p(String value)	Sets the Schema.p() property on this annotation.
SchemaAnnotation.Builder	pattern(String value)	Sets the Schema.pattern() property on this annotation.
SchemaAnnotation.Builder	properties(String... value)	Sets the Schema.properties() property on this annotation.
SchemaAnnotation.Builder	r(boolean value)	Sets the Schema.r() property on this annotation.
SchemaAnnotation.Builder	readOnly(boolean value)	Sets the Schema.readOnly() property on this annotation.
SchemaAnnotation.Builder	required(boolean value)	Sets the Schema.required() property on this annotation.
SchemaAnnotation.Builder	ro(boolean value)	Sets the Schema.ro() property on this annotation.
SchemaAnnotation.Builder	sie(boolean value)	Sets the Schema.sie() property on this annotation.
SchemaAnnotation.Builder	skipIfEmpty(boolean value)	Sets the Schema.skipIfEmpty() property on this annotation.
SchemaAnnotation.Builder	t(String value)	Sets the Schema.t() property on this annotation.
SchemaAnnotation.Builder	title(String value)	Sets the Schema.title() property on this annotation.
SchemaAnnotation.Builder	type(String value)	Sets the Schema.type() property on this annotation.
SchemaAnnotation.Builder	ui(boolean value)	Sets the Schema.ui() property on this annotation.
SchemaAnnotation.Builder	uniqueItems(boolean value)	Sets the Schema.uniqueItems() property on this annotation.
SchemaAnnotation.Builder	xml(String... value)	Sets the Schema.xml() property on this annotation.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor.

Method Details

build

public Schema build()

Instantiates a new @Schema object initialized with this builder.

Returns:

A new @Schema object.

_default

public SchemaAnnotation.Builder _default(String... value)

Sets the Schema._default() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

_enum

public SchemaAnnotation.Builder _enum(String... value)

Sets the Schema._enum() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

$ref

public SchemaAnnotation.Builder $ref(String value)

Sets the Schema.$ref() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

additionalProperties

public SchemaAnnotation.Builder additionalProperties(String... value)

Sets the Schema.additionalProperties() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

allOf

public SchemaAnnotation.Builder allOf(String... value)

Sets the Schema.allOf() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

aev

public SchemaAnnotation.Builder aev(boolean value)

Sets the Schema.aev() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

allowEmptyValue

public SchemaAnnotation.Builder allowEmptyValue(boolean value)

Sets the Schema.allowEmptyValue() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

cf

public SchemaAnnotation.Builder cf(String value)

Sets the Schema.cf() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

collectionFormat

public SchemaAnnotation.Builder collectionFormat(String value)

Sets the Schema.collectionFormat() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

d

public SchemaAnnotation.Builder d(String... value)

Sets the Schema.d() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

description

public SchemaAnnotation.Builder description(String... value)

Sets the Schema.description() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

df

public SchemaAnnotation.Builder df(String... value)

Sets the Schema.df() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

discriminator

public SchemaAnnotation.Builder discriminator(String value)

Sets the Schema.discriminator() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

e

public SchemaAnnotation.Builder e(String... value)

Sets the Schema.e() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

emax

public SchemaAnnotation.Builder emax(boolean value)

Sets the Schema.emax() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

emin

public SchemaAnnotation.Builder emin(boolean value)

Sets the Schema.emin() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

exclusiveMaximum

public SchemaAnnotation.Builder exclusiveMaximum(boolean value)

Sets the Schema.exclusiveMaximum() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

exclusiveMinimum

public SchemaAnnotation.Builder exclusiveMinimum(boolean value)

Sets the Schema.exclusiveMinimum() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

externalDocs

public SchemaAnnotation.Builder externalDocs(ExternalDocs value)

Sets the Schema.externalDocs() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

f

public SchemaAnnotation.Builder f(String value)

Sets the Schema.f() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

format

public SchemaAnnotation.Builder format(String value)

Sets the Schema.format() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

ignore

public SchemaAnnotation.Builder ignore(boolean value)

Sets the Schema.ignore() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

items

public SchemaAnnotation.Builder items(Items value)

Sets the Schema.items() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

max

public SchemaAnnotation.Builder max(String value)

Sets the Schema.max() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

maxi

public SchemaAnnotation.Builder maxi(long value)

Sets the Schema.maxi() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

maximum

public SchemaAnnotation.Builder maximum(String value)

Sets the Schema.maximum() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

maxItems

public SchemaAnnotation.Builder maxItems(long value)

Sets the Schema.maxItems() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

maxl

public SchemaAnnotation.Builder maxl(long value)

Sets the Schema.maxl() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

maxLength

public SchemaAnnotation.Builder maxLength(long value)

Sets the Schema.maxLength() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

maxp

public SchemaAnnotation.Builder maxp(long value)

Sets the Schema.maxp() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

maxProperties

public SchemaAnnotation.Builder maxProperties(long value)

Sets the Schema.maxProperties() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

min

public SchemaAnnotation.Builder min(String value)

Sets the Schema.min() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

mini

public SchemaAnnotation.Builder mini(long value)

Sets the Schema.mini() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

minimum

public SchemaAnnotation.Builder minimum(String value)

Sets the Schema.minimum() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

minItems

public SchemaAnnotation.Builder minItems(long value)

Sets the Schema.minItems() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

minl

public SchemaAnnotation.Builder minl(long value)

Sets the Schema.minl() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

minLength

public SchemaAnnotation.Builder minLength(long value)

Sets the Schema.minLength() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

minp

public SchemaAnnotation.Builder minp(long value)

Sets the Schema.minp() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

minProperties

public SchemaAnnotation.Builder minProperties(long value)

Sets the Schema.minProperties() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

mo

public SchemaAnnotation.Builder mo(String value)

Sets the Schema.mo() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

multipleOf

public SchemaAnnotation.Builder multipleOf(String value)

Sets the Schema.multipleOf() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

p

public SchemaAnnotation.Builder p(String value)

Sets the Schema.p() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

pattern

public SchemaAnnotation.Builder pattern(String value)

Sets the Schema.pattern() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

properties

public SchemaAnnotation.Builder properties(String... value)

Sets the Schema.properties() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

r

public SchemaAnnotation.Builder r(boolean value)

Sets the Schema.r() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

readOnly

public SchemaAnnotation.Builder readOnly(boolean value)

Sets the Schema.readOnly() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

required

public SchemaAnnotation.Builder required(boolean value)

Sets the Schema.required() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

ro

public SchemaAnnotation.Builder ro(boolean value)

Sets the Schema.ro() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

sie

public SchemaAnnotation.Builder sie(boolean value)

Sets the Schema.sie() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

skipIfEmpty

public SchemaAnnotation.Builder skipIfEmpty(boolean value)

Sets the Schema.skipIfEmpty() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

t

public SchemaAnnotation.Builder t(String value)

Sets the Schema.t() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

title

public SchemaAnnotation.Builder title(String value)

Sets the Schema.title() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

type

public SchemaAnnotation.Builder type(String value)

Sets the Schema.type() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

ui

public SchemaAnnotation.Builder ui(boolean value)

Sets the Schema.ui() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

uniqueItems

public SchemaAnnotation.Builder uniqueItems(boolean value)

Sets the Schema.uniqueItems() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

xml

public SchemaAnnotation.Builder xml(String... value)

Sets the Schema.xml() property on this annotation.

Parameters:

value - The new value for this property.

Returns:

This object.

on

public SchemaAnnotation.Builder on(String... values)

Description copied from class: TargetedAnnotationBuilder

The targets this annotation applies to.

Overrides:

on in class TargetedAnnotationTMFBuilder

Parameters:

values - The targets this annotation applies to.

Returns:

This object.

on

public SchemaAnnotation.Builder on(Class<?>... value)

Description copied from class: TargetedAnnotationTBuilder

Appends the classes that this annotation applies to.

Overrides:

on in class TargetedAnnotationTMFBuilder

Parameters:

value - The values to append.

Returns:

This object.

onClass

public SchemaAnnotation.Builder onClass(Class<?>... value)

Description copied from class: TargetedAnnotationTBuilder

Appends the classes that this annotation applies to.

Overrides:

onClass in class TargetedAnnotationTMFBuilder

Parameters:

value - The values to append.

Returns:

This object.

on

public SchemaAnnotation.Builder on(Field... value)

Description copied from class: TargetedAnnotationTMFBuilder

Appends the fields that this annotation applies to.

Overrides:

on in class TargetedAnnotationTMFBuilder

Parameters:

value - The values to append.

Returns:

This object.

on

public SchemaAnnotation.Builder on(Method... value)

Description copied from class: TargetedAnnotationTMFBuilder

Appends the methods that this annotation applies to.

Overrides:

on in class TargetedAnnotationTMFBuilder

Parameters:

value - The values to append.

Returns:

This object.