Package org.apache.juneau.marshall.json

Class JsonSchemaSerializer.Builder

java.lang.Object

org.apache.juneau.marshall.Context.Builder<SELF>

org.apache.juneau.marshall.MarshallingContextable.Builder<SELF>

org.apache.juneau.marshall.MarshallingTraverseContext.Builder<SELF>

org.apache.juneau.marshall.serializer.Serializer.Builder<SELF>

org.apache.juneau.marshall.serializer.WriterSerializer.Builder<SELF>

org.apache.juneau.marshall.json.JsonSerializer.Builder<JsonSchemaSerializer.Builder>

org.apache.juneau.marshall.json.JsonSchemaSerializer.Builder

Enclosing class:

JsonSchemaSerializer

public static class JsonSchemaSerializer.Builder
extends JsonSerializer.Builder<JsonSchemaSerializer.Builder>

Builder class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Constructor, default settings.
protected	Builder(JsonSchemaSerializer copyFrom)	Copy constructor.
protected	Builder(JsonSchemaSerializer.Builder copyFrom)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
JsonSchemaSerializer.Builder	addDescriptionsTo(TypeCategory... values)	JsonSchemaSerializer configuration property:  Add descriptions.
JsonSchemaSerializer.Builder	addExamplesTo(TypeCategory... values)	JsonSchemaSerializer configuration property:  Add examples.
JsonSchemaSerializer.Builder	allowNestedDescriptions()	JsonSchemaSerializer configuration property:  Allow nested descriptions.
JsonSchemaSerializer.Builder	allowNestedExamples()	JsonSchemaSerializer configuration property:  Allow nested examples.
JsonSchemaSerializer.Builder	beanDefMapper(Class<? extends MarshallingDefMapper> value)	JsonSchemaSerializer configuration property:  Schema definition mapper.
JsonSchemaSerializer	build()	Build the object.
JsonSchemaSerializer.Builder	copy()	Copy creator.
HashKey	hashKey()	Returns the hashkey of this builder.
JsonSchemaSerializer.Builder	useBeanDefs()	JsonSchemaSerializer configuration property:  Use bean definitions.

Methods inherited from class org.apache.juneau.marshall.json.JsonSerializer.Builder

addBeanTypesJson, addBeanTypesJson, escapeSolidus, escapeSolidus

Methods inherited from class org.apache.juneau.marshall.serializer.WriterSerializer.Builder

maxIndent, quoteChar, quoteCharOverride, sq, streamCharset, useWhitespace, useWhitespace, ws

Methods inherited from class org.apache.juneau.marshall.serializer.Serializer.Builder

accept, addBeanTypes, addBeanTypes, addRootType, addRootType, getAccept, getProduces, keepNullProperties, keepNullProperties, listener, nonDefault, nonDefault, produces, sortCollections, sortCollections, sortMaps, sortMaps, trimEmptyCollections, trimEmptyCollections, trimEmptyMaps, trimEmptyMaps, trimStrings, trimStrings, uriContext, uriRelativity, uriResolution

Methods inherited from class org.apache.juneau.marshall.MarshallingTraverseContext.Builder

detectRecursions, detectRecursions, ignoreRecursions, ignoreRecursions, initialDepth, maxDepth

Methods inherited from class org.apache.juneau.marshall.MarshallingContextable.Builder

activeView, annotations, beanClassVisibility, beanConstructorVisibility, beanDictionary, beanFieldVisibility, beanInterceptor, beanMapPutReturnsOldValue, beanMethodVisibility, beanProperties, beanProperties, beanProperties, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesExcludes, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesReadOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beanPropertiesWriteOnly, beansRequireDefaultConstructor, beansRequireSerializable, beansRequireSettersForGetters, bigNumberFormat, binaryFormat, bitSetFormat, booleanFormat, calendarFormat, classFormat, classLoader, currencyFormat, dateFormat, debug, dictionaryOn, disableBeansRequireSomeProperties, disableDefaultViewInclusion, disableIgnoreMissingSetters, disableIgnoreTransientFields, disableIgnoreUnknownNullBeanProperties, disableInterfaceProxies, durationFormat, enumFormat, example, example, findFluentSetters, findFluentSetters, floatFormat, ignoreInvocationExceptionsOnGetters, ignoreInvocationExceptionsOnSetters, ignoreUnknownBeanProperties, ignoreUnknownEnumValues, implClass, implClasses, interfaceClass, interfaces, locale, localeFormat, marshallingContext, marshallingContext, marshallingContext, marshallingContext, mediaType, notBeanClasses, notBeanPackages, periodFormat, propertyNamer, propertyNamer, recordComponentOrder, stopClass, swap, swap, swaps, swaps, temporalFormat, timeZone, timeZoneFormat, typeName, typePropertyName, typePropertyName, unsortedProperties, unsortedProperties, useJavaBeanIntrospector, uuidFormat, validateSchema, validateSchema

Methods inherited from class org.apache.juneau.marshall.Context.Builder

annotations, apply, applyAnnotations, applyAnnotations, asSubtype, build, cache, canApply, copyOrNull, debug, getApplied, getType, impl, isDebug, registerBuilders, self, type

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Constructor, default settings.

Builder

protected Builder(JsonSchemaSerializer.Builder copyFrom)

Copy constructor.

Parameters:

copyFrom - The builder to copy from.
Cannot be null.

Builder

protected Builder(JsonSchemaSerializer copyFrom)

Copy constructor.

Parameters:

copyFrom - The bean to copy from.
Cannot be null.

Method Details

addDescriptionsTo

public JsonSchemaSerializer.Builder addDescriptionsTo(TypeCategory... values)

JsonSchemaSerializer configuration property:  Add descriptions.

Identifies which categories of types that descriptions should be automatically added to generated schemas.

The description is the result of calling ClassInfo.getName().

See Also:

• JsonSchemaGenerator.Builder#addDescriptionsTo(TypeCategory...)

Parameters:

values - The values to add to this setting.
The default is an empty string.

Returns:

This object.

addExamplesTo

public JsonSchemaSerializer.Builder addExamplesTo(TypeCategory... values)

JsonSchemaSerializer configuration property:  Add examples.

Identifies which categories of types that examples should be automatically added to generated schemas.

The examples come from calling ClassMeta.getExample(MarshallingSession,JsonParserSession) which in turn gets examples from the following:

• Example
• Marshalled(example)

See Also:

• JsonSchemaGenerator.Builder#addExamplesTo(TypeCategory...)

Parameters:

values - The values to add to this setting.
The default is an empty string.

Returns:

This object.

allowNestedDescriptions

public JsonSchemaSerializer.Builder allowNestedDescriptions()

JsonSchemaSerializer configuration property:  Allow nested descriptions.

Identifies whether nested descriptions are allowed in schema definitions.

See Also:

• JsonSchemaGenerator.Builder#allowNestedDescriptions()

Returns:

This object.

allowNestedExamples

public JsonSchemaSerializer.Builder allowNestedExamples()

JsonSchemaSerializer configuration property:  Allow nested examples.

Identifies whether nested examples are allowed in schema definitions.

See Also:

• JsonSchemaGenerator.Builder#allowNestedExamples()

Returns:

This object.

beanDefMapper

public JsonSchemaSerializer.Builder beanDefMapper(Class<? extends MarshallingDefMapper> value)

JsonSchemaSerializer configuration property:  Schema definition mapper.

Interface to use for converting Bean classes to definition IDs and URIs.

Used primarily for defining common definition sections for beans in Swagger JSON.

This setting is ignored if JsonSchemaGenerator.Builder#useBeanDefs() is not enabled.

See Also:

• JsonSchemaGenerator.Builder#beanDefMapper(Class)

Parameters:

value - The new value for this property.
The default is BasicBeanDefMapper.

Returns:

This object.

build

public JsonSchemaSerializer build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class JsonSerializer.Builder<JsonSchemaSerializer.Builder>

Returns:

The built object.

copy

public JsonSchemaSerializer.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class JsonSerializer.Builder<JsonSchemaSerializer.Builder>

Returns:

A new mutable copy of this builder.

hashKey

public HashKey hashKey()

Description copied from class: Context.Builder

Returns the hashkey of this builder.

Used to return previously instantiated context beans that have matching hashkeys. The HashKey object is suitable for use as a hashmap key of a map of context beans. A context bean is considered equivalent if the HashKey.equals(Object) method is the same.

Overrides:

hashKey in class JsonSerializer.Builder<JsonSchemaSerializer.Builder>

Returns:

The hashkey of this builder.

useBeanDefs

public JsonSchemaSerializer.Builder useBeanDefs()

JsonSchemaSerializer configuration property:  Use bean definitions.

When enabled, schemas on beans will be serialized as the following:

{ type: 'object', '$ref': '#/definitions/TypeId' }

Returns:

This object.