Package org.apache.juneau.json

Class JsonSchemaSerializer

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.BeanTraverseContext

org.apache.juneau.serializer.Serializer

org.apache.juneau.serializer.WriterSerializer

org.apache.juneau.json.JsonSerializer

org.apache.juneau.json.JsonSchemaSerializer

All Implemented Interfaces:

AnnotationProvider, JsonMetaProvider, JsonSchemaMetaProvider

Direct Known Subclasses:

JsonSchemaSerializer.Readable, JsonSchemaSerializer.Simple, JsonSchemaSerializer.SimpleReadable

public class JsonSchemaSerializer
extends JsonSerializer
implements JsonSchemaMetaProvider

Serializes POJO metadata to HTTP responses as JSON-Schema.

Media types

Handles Accept types: application/json+schema, text/json+schema

Produces Content-Type types: application/json

Description

Produces the JSON-schema for the JSON produced by the JsonSerializer class with the same properties.

Notes:

• This class is thread safe and reusable.

See Also:

• JSON Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonSchemaSerializer.Builder	Builder class.
static class	JsonSchemaSerializer.Readable	Default serializer, with whitespace.
static class	JsonSchemaSerializer.Simple	Default serializer, single quotes, simple mode.
static class	JsonSchemaSerializer.SimpleReadable	Default serializer, single quotes, simple mode, with whitespace.

Nested classes/interfaces inherited from class org.apache.juneau.json.JsonSerializer

JsonSerializer.ReadableSafe

Nested classes/interfaces inherited from class org.apache.juneau.serializer.Serializer

Serializer.Null

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonSchemaSerializer	DEFAULT	Default serializer, all default settings.
static final JsonSchemaSerializer	DEFAULT_READABLE	Default serializer, all default settings.
static final JsonSchemaSerializer	DEFAULT_SIMPLE	Default serializer, single quotes, simple mode.
static final JsonSchemaSerializer	DEFAULT_SIMPLE_READABLE	Default serializer, single quotes, simple mode, with whitespace.

Fields inherited from class org.apache.juneau.json.JsonSerializer

DEFAULT_SORTED

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Fields inherited from interface org.apache.juneau.AnnotationProvider

DISABLE_ANNOTATION_CACHING

Constructor Summary

Constructors

Constructor	Description
JsonSchemaSerializer(JsonSchemaSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
JsonSchemaSerializer.Builder	copy()	Creates a builder from this context object.
static JsonSchemaSerializer.Builder	create()	Creates a new builder for this object.
JsonSchemaSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
JsonSchemaBeanPropertyMeta	getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
JsonSchemaClassMeta	getJsonSchemaClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
JsonSchemaSerializerSession	getSession()	Returns a session to use for this context.
protected JsonMap	properties()	Returns the properties on this bean as a map for debugging.

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

getJsonBeanPropertyMeta, getJsonClassMeta, getSchemaSerializer, isAddBeanTypes, isEscapeSolidus, isSimpleAttrs

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

getFileCharset, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, serialize, toString

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

createSerializerBuilder, doSerialize, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString

Methods inherited from class org.apache.juneau.BeanTraverseContext

getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, init, isDebug, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.juneau.AnnotationProvider

firstAnnotation, firstAnnotation, firstAnnotation, firstAnnotation, firstDeclaredAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachAnnotation, forEachDeclaredAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastAnnotation, lastDeclaredAnnotation

Field Details

DEFAULT

public static final JsonSchemaSerializer DEFAULT

Default serializer, all default settings.

DEFAULT_READABLE

public static final JsonSchemaSerializer DEFAULT_READABLE

Default serializer, all default settings.

DEFAULT_SIMPLE

public static final JsonSchemaSerializer DEFAULT_SIMPLE

Default serializer, single quotes, simple mode.

DEFAULT_SIMPLE_READABLE

public static final JsonSchemaSerializer DEFAULT_SIMPLE_READABLE

Default serializer, single quotes, simple mode, with whitespace.

Constructor Details

JsonSchemaSerializer

public JsonSchemaSerializer(JsonSchemaSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static JsonSchemaSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public JsonSchemaSerializer.Builder copy()

Description copied from class: Context

Creates a builder from this context object.

Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.

Overrides:

copy in class JsonSerializer

Returns:

A new Builder object.

createSession

public JsonSchemaSerializerSession.Builder createSession()

Description copied from class: Context

Create a session builder based on the properties defined on this context.

Use this method for creating sessions where you want to override basic settings. Otherwise, use Context.getSession() directly.

Overrides:

createSession in class JsonSerializer

Returns:

A new session builder.

getSession

public JsonSchemaSerializerSession getSession()

Description copied from class: Context

Returns a session to use for this context.

Note that subclasses may opt to return a reusable non-modifiable session.

Overrides:

getSession in class JsonSerializer

Returns:

A new session object.

getJsonSchemaClassMeta

public JsonSchemaClassMeta getJsonSchemaClassMeta(ClassMeta<?> cm)

Description copied from interface: JsonSchemaMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getJsonSchemaClassMeta in interface JsonSchemaMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getJsonSchemaBeanPropertyMeta

public JsonSchemaBeanPropertyMeta getJsonSchemaBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: JsonSchemaMetaProvider

Returns the language-specific metadata on the specified bean property.

Specified by:

getJsonSchemaBeanPropertyMeta in interface JsonSchemaMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

properties

protected JsonMap properties()

Description copied from class: Context

Returns the properties on this bean as a map for debugging.

Overrides:

properties in class JsonSerializer

Returns:

The properties on this bean as a map for debugging.