Package org.apache.juneau.oapi

Class OpenApiSerializer

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.uon.UonSerializer

org.apache.juneau.oapi.OpenApiSerializer

All Implemented Interfaces:

HttpPartSerializer, OpenApiMetaProvider, UonMetaProvider

public class OpenApiSerializer
extends UonSerializer
implements OpenApiMetaProvider

Serializes POJOs to values suitable for transmission as HTTP headers, query/form-data parameters, and path variables.

Notes:

• This class is thread safe and reusable.

See Also:

• OpenApi Basics

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenApiSerializer.Builder	Builder class.

Nested classes/interfaces inherited from class org.apache.juneau.uon.UonSerializer

UonSerializer.Encoding, UonSerializer.Readable

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

Serializer.Null

Nested classes/interfaces inherited from interface org.apache.juneau.httppart.HttpPartSerializer

HttpPartSerializer.Creator, HttpPartSerializer.Void

Field Summary

Fields

Modifier and Type	Field	Description
static final OpenApiSerializer	DEFAULT	Reusable instance of OpenApiSerializer, all default settings.

Fields inherited from class org.apache.juneau.uon.UonSerializer

addBeanTypesUon, DEFAULT_ENCODING, DEFAULT_READABLE, encoding, paramFormat, quoteCharUon

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

maxIndent, quoteCharOverride, useWhitespace

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

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

Fields inherited from class org.apache.juneau.BeanContextable

beanContext

Fields inherited from class org.apache.juneau.Context

CONTEXT_APPLY_FILTER

Constructor Summary

Constructors

Constructor	Description
OpenApiSerializer(OpenApiSerializer.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
OpenApiSerializer.Builder	copy()	Creates a builder from this context object.
static OpenApiSerializer.Builder	create()	Creates a new builder for this object.
OpenApiSerializerSession.Builder	createSession()	Create a session builder based on the properties defined on this context.
protected final HttpPartCollectionFormat	getCollectionFormat()	Returns the default collection format to use when not otherwise specified via Schema.collectionFormat()
protected final HttpPartFormat	getFormat()	Returns the default format to use when not otherwise specified via Schema.format()
OpenApiBeanPropertyMeta	getOpenApiBeanPropertyMeta(BeanPropertyMeta bpm)	Returns the language-specific metadata on the specified bean property.
OpenApiClassMeta	getOpenApiClassMeta(ClassMeta<?> cm)	Returns the language-specific metadata on the specified class.
OpenApiSerializerSession	getPartSession()	Creates a new serializer session.
OpenApiSerializerSession	getSession()	Returns a session to use for this context.

Methods inherited from class org.apache.juneau.uon.UonSerializer

getParamFormat, getQuoteChar, getUonBeanPropertyMeta, getUonClassMeta, isAddBeanTypes, isEncoding, properties, serialize

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

getFileCharset, getMaxIndent, 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

getDetectRecursions, getIgnoreRecursions, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions

Methods inherited from class org.apache.juneau.BeanContextable

getBeanContext

Methods inherited from class org.apache.juneau.Context

createBuilder, getAnnotationProvider, init, isDebug, toString

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT

public static final OpenApiSerializer DEFAULT

Reusable instance of OpenApiSerializer, all default settings.

Constructor Details

OpenApiSerializer

public OpenApiSerializer(OpenApiSerializer.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static OpenApiSerializer.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public OpenApiSerializer.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 UonSerializer

Returns:

A new Builder object.

createSession

public OpenApiSerializerSession.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 UonSerializer

Returns:

A new session builder.

getOpenApiBeanPropertyMeta

public OpenApiBeanPropertyMeta getOpenApiBeanPropertyMeta(BeanPropertyMeta bpm)

Description copied from interface: OpenApiMetaProvider

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

Specified by:

getOpenApiBeanPropertyMeta in interface OpenApiMetaProvider

Parameters:

bpm - The bean property to return the metadata on.

Returns:

The metadata.

getOpenApiClassMeta

public OpenApiClassMeta getOpenApiClassMeta(ClassMeta<?> cm)

Description copied from interface: OpenApiMetaProvider

Returns the language-specific metadata on the specified class.

Specified by:

getOpenApiClassMeta in interface OpenApiMetaProvider

Parameters:

cm - The class to return the metadata on.

Returns:

The metadata.

getPartSession

public OpenApiSerializerSession getPartSession()

Description copied from interface: HttpPartSerializer

Creates a new serializer session.

Specified by:

getPartSession in interface HttpPartSerializer

Overrides:

getPartSession in class UonSerializer

Returns:

A new serializer session.

getSession

public OpenApiSerializerSession 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 UonSerializer

Returns:

A new session object.

getCollectionFormat

protected final HttpPartCollectionFormat getCollectionFormat()

Returns the default collection format to use when not otherwise specified via Schema.collectionFormat()

Returns:

The default collection format to use when not otherwise specified via Schema.collectionFormat()

getFormat

protected final HttpPartFormat getFormat()

Returns the default format to use when not otherwise specified via Schema.format()

Returns:

The default format to use when not otherwise specified via Schema.format()