Package org.apache.juneau.marshall.json

Class JsonSchemaSerializer

java.lang.Object

org.apache.juneau.marshall.Context

org.apache.juneau.marshall.MarshallingContextable

org.apache.juneau.marshall.MarshallingTraverseContext

org.apache.juneau.marshall.serializer.Serializer

org.apache.juneau.marshall.serializer.WriterSerializer

org.apache.juneau.marshall.json.JsonSerializer

org.apache.juneau.marshall.json.JsonSchemaSerializer

All Implemented Interfaces:

Function<Object,String>, ThrowingFunction<Object,String>, JsonMetaProvider, JsonSchemaMetaProvider, ArrayRecordWritable, RecordWritable, TokenWritable

Direct Known Subclasses:

JsonSchemaSerializer.Readable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JsonSchemaSerializer.Builder	Builder class.
static class	JsonSchemaSerializer.Readable	Default serializer, with whitespace.

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

JsonSerializer.DefaultBuilder

Nested classes/interfaces inherited from class org.apache.juneau.marshall.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.

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

addBeanTypesJson, escapeSolidus

Fields inherited from class org.apache.juneau.marshall.serializer.WriterSerializer

maxIndent, quoteChar, quoteCharOverride, useWhitespace

Fields inherited from class org.apache.juneau.marshall.serializer.Serializer

accept, addBeanTypes, addRootType, keepNullProperties, listener, nonDefault, produces, sortCollections, sortMaps, trimEmptyCollections, trimEmptyMaps, trimStrings

Fields inherited from class org.apache.juneau.marshall.MarshallingContextable

marshallingContext

Fields inherited from class org.apache.juneau.marshall.Context

CONTEXT_APPLY_FILTER

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.
boolean	isRecordStreaming()	Streaming-quality signal queryable before opening a cursor.
protected FluentMap<String,Object>	properties()	Returns the properties on this bean as a map for debugging.
RecordWriter	writeRecords(Object output)	Convenience delegator (default session args) for a record writer that emits the JSON Schema for each value passed to write(...).
TokenWriter	writeTokens(Object output)	Convenience delegator (default session args) for the raw-JSON token writer.

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

getJsonBeanPropertyMeta, getJsonClassMeta, getSchemaSerializer, isAddBeanTypes, isEscapeSolidus, writeArrayRecords

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

applyThrows, getMaxIndent, getQuoteChar, getStreamCharset, isUseWhitespace, isWriterSerializer, println, quoteChar, toString, write

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

createSerializerBuilder, doWrite, forEachAcceptMediaType, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getResponseHeaders, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isNonDefault, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, write, writeToString

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

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions, shouldDetectRecursions

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

getDurationFormat, getMarshallingContext, getPeriodFormat

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

createBuilder, getAnnotationProvider, init, isDebug, 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.marshall.stream.ArrayRecordWritable

isArrayRecordStreaming, writeArrayRecords

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface org.apache.juneau.commons.function.ThrowingFunction

apply

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.

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.

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.

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.

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.

writeTokens

public TokenWriter writeTokens(Object output)
                        throws IOException

Convenience delegator (default session args) for the raw-JSON token writer. Real impl on JsonSchemaSerializerSession.writeTokens(Object).

Note: the cursor's structural methods produce ordinary JSON regardless of the JsonSchema-aware WriterSerializer.write(Object) path; the object(Object) bridge is disabled. Use WriterSerializer.write(Object) for schema generation, or compose the schema manually via the structural methods.

Specified by:

writeTokens in interface TokenWritable

Overrides:

writeTokens in class JsonSerializer

Parameters:

output - The output.

Returns:

A new JsonTokenWriter with object(...) disabled.

Throws:

IOException - If the output type is not supported or could not be opened.

writeRecords

public RecordWriter writeRecords(Object output)
                          throws IOException

Convenience delegator (default session args) for a record writer that emits the JSON Schema for each value passed to write(...). Real impl on JsonSchemaSerializerSession.writeRecords(Object).

Specified by:

writeRecords in interface RecordWritable

Specified by:

writeRecords in interface TokenWritable

Parameters:

output - The output.

Returns:

A new RecordWriter.

Throws:

IOException - If the output type is not supported or could not be opened.

isRecordStreaming

public boolean isRecordStreaming()

Description copied from interface: RecordWritable

Streaming-quality signal queryable before opening a cursor.

Specified by:

isRecordStreaming in interface RecordWritable

Returns:

true if RecordWritable.writeRecords(Object) returns an O(1)-memory streaming cursor; false for buffered (whole-value) formats backed by RecordAdapter.

properties

protected FluentMap<String,Object> 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.