Package org.apache.juneau.marshall.jsonschema

Class JsonSchemaGenerator.Builder

java.lang.Object

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

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

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

org.apache.juneau.marshall.jsonschema.JsonSchemaGenerator.Builder

Enclosing class:

JsonSchemaGenerator

public static class JsonSchemaGenerator.Builder
extends MarshallingTraverseContext.Builder<JsonSchemaGenerator.Builder>

Builder class.

Field Summary

Fields

Modifier and Type	Field	Description
protected final JsonParser.Builder<?>	jsonParserBuilder
protected final JsonSerializer.Builder<?>	jsonSerializerBuilder

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
JsonSchemaGenerator.Builder	addDescriptionsTo(TypeCategory... values)	Add descriptions.
JsonSchemaGenerator.Builder	addExamplesTo(TypeCategory... values)	Add examples.
JsonSchemaGenerator.Builder	allowNestedDescriptions()	Allow nested descriptions.
JsonSchemaGenerator.Builder	allowNestedDescriptions(boolean value)	Same as allowNestedDescriptions() but allows you to explicitly specify the value.
JsonSchemaGenerator.Builder	allowNestedExamples()	Allow nested examples.
JsonSchemaGenerator.Builder	allowNestedExamples(boolean value)	Same as allowNestedExamples() but allows you to explicitly specify the value.
JsonSchemaGenerator.Builder	beanDefMapper(Class<? extends MarshallingDefMapper> value)	Schema definition mapper.
JsonSchemaGenerator	build()	Build the object.
JsonSchemaGenerator.Builder	copy()	Copy creator.
JsonParser.Builder<?>	getJsonParserBuilder()	Gives access to the inner JSON parser builder if you want to modify the parser settings.
JsonSerializer.Builder<?>	getJsonSerializerBuilder()	Gives access to the inner JSON serializer builder if you want to modify the serializer settings.
HashKey	hashKey()	Returns the hashkey of this builder.
JsonSchemaGenerator.Builder	ignoreTypes(String... values)	Ignore types from schema definitions.
JsonSchemaGenerator.Builder	useBeanDefs()	Use bean definitions.
JsonSchemaGenerator.Builder	useBeanDefs(boolean value)	Same as useBeanDefs() but allows you to explicitly specify the value.

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

Field Details

jsonParserBuilder

protected final JsonParser.Builder<?> jsonParserBuilder

jsonSerializerBuilder

protected final JsonSerializer.Builder<?> jsonSerializerBuilder

Constructor Details

Builder

protected Builder()

Constructor, default settings.

Builder

protected Builder(JsonSchemaGenerator.Builder copyFrom)

Copy constructor.

Parameters:

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

Builder

protected Builder(JsonSchemaGenerator copyFrom)

Copy constructor.

Parameters:

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

Method Details

addDescriptionsTo

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

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(). The format is a comma-delimited list of any of the following values:

• BEAN
• COLLECTION
• ARRAY
• MAP
• STRING
• NUMBER
• BOOLEAN
• ANY
• OTHER

Parameters:

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

Returns:

This object.

addExamplesTo

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

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)

The format is a comma-delimited list of any of the following values:

• BEAN
• COLLECTION
• ARRAY
• MAP
• STRING
• NUMBER
• BOOLEAN
• ANY
• OTHER

Parameters:

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

Returns:

This object.

allowNestedDescriptions

public JsonSchemaGenerator.Builder allowNestedDescriptions()

Allow nested descriptions.

Identifies whether nested descriptions are allowed in schema definitions.

Returns:

This object.

allowNestedDescriptions

public JsonSchemaGenerator.Builder allowNestedDescriptions(boolean value)

Same as allowNestedDescriptions() but allows you to explicitly specify the value.

Parameters:

value - The value for this setting.

Returns:

This object.

allowNestedExamples

public JsonSchemaGenerator.Builder allowNestedExamples()

Allow nested examples.

Identifies whether nested examples are allowed in schema definitions.

Returns:

This object.

allowNestedExamples

public JsonSchemaGenerator.Builder allowNestedExamples(boolean value)

Same as allowNestedExamples() but allows you to explicitly specify the value.

Parameters:

value - The value for this setting.

Returns:

This object.

beanDefMapper

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

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 useBeanDefs() is not enabled.

Parameters:

value - The new value for this setting.
The default is BasicBeanDefMapper.
Cannot be null.

Returns:

This object.

build

public JsonSchemaGenerator build()

Description copied from class: Context.Builder

Build the object.

Overrides:

build in class Context.Builder<JsonSchemaGenerator.Builder>

Returns:

The built object.

copy

public JsonSchemaGenerator.Builder copy()

Description copied from class: Context.Builder

Copy creator.

Specified by:

copy in class MarshallingContextable.Builder<JsonSchemaGenerator.Builder>

Returns:

A new mutable copy of this builder.

getJsonParserBuilder

public JsonParser.Builder<?> getJsonParserBuilder()

Gives access to the inner JSON parser builder if you want to modify the parser settings.

Returns:

The JSON serializer builder.

getJsonSerializerBuilder

public JsonSerializer.Builder<?> getJsonSerializerBuilder()

Gives access to the inner JSON serializer builder if you want to modify the serializer settings.

Returns:

The JSON serializer 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 MarshallingTraverseContext.Builder<JsonSchemaGenerator.Builder>

Returns:

The hashkey of this builder.

ignoreTypes

public JsonSchemaGenerator.Builder ignoreTypes(String... values)

Ignore types from schema definitions.

Description:

Defines class name patterns that should be ignored when generating schema definitions in the generated Swagger documentation.

Example:

// Don't generate schema for any prototype packages or the class named 'Swagger'. @JsonSchemaConfig( ignoreTypes="Swagger,*.proto.*" ) public class MyResource {...}

Parameters:

values - The values to add.
Cannot contain null values.

Returns:

This object.

useBeanDefs

public JsonSchemaGenerator.Builder useBeanDefs()

Use bean definitions.

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

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

The definitions can then be retrieved from the session using JsonSchemaGeneratorSession.getBeanDefs().

Definitions can also be added programmatically using JsonSchemaGeneratorSession.addBeanDef(String, JsonMap).

Returns:

This object.

useBeanDefs

public JsonSchemaGenerator.Builder useBeanDefs(boolean value)

Same as useBeanDefs() but allows you to explicitly specify the value.

Parameters:

value - The value for this setting.

Returns:

This object.