Package org.apache.juneau.oapi

Class OpenApiParser

java.lang.Object

org.apache.juneau.Context

org.apache.juneau.BeanContextable

org.apache.juneau.parser.Parser

org.apache.juneau.parser.ReaderParser

org.apache.juneau.uon.UonParser

org.apache.juneau.oapi.OpenApiParser

All Implemented Interfaces:

AnnotationProvider, HttpPartParser, OpenApiMetaProvider, UonMetaProvider

public class OpenApiParser
extends UonParser
implements OpenApiMetaProvider

OpenAPI part parser.

Notes:

• This class is thread safe and reusable.

See Also:

• OpenApi Basics

Nested Class Summary

Nested Classes

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

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

UonParser.Decoding

Nested classes/interfaces inherited from class org.apache.juneau.parser.Parser

Parser.Null

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

HttpPartParser.Creator, HttpPartParser.Void

Field Summary

Fields

Modifier and Type	Field	Description
static final OpenApiParser	DEFAULT	Reusable instance of OpenApiParser.

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

DEFAULT_DECODING

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
OpenApiParser(OpenApiParser.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
OpenApiParser.Builder	copy()	Creates a builder from this context object.
static OpenApiParser.Builder	create()	Creates a new builder for this object.
OpenApiParserSession.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.
OpenApiParserSession	getPartSession()	Creates a new parser session.
OpenApiParserSession	getSession()	Returns a session to use for this context.

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

getClassMeta, getClassMeta, getUonBeanPropertyMeta, getUonClassMeta, isDecoding, isValidateEnd, parse, parse, parse, properties

Methods inherited from class org.apache.juneau.parser.ReaderParser

getFileCharset, getStreamCharset, isReaderParser

Methods inherited from class org.apache.juneau.parser.Parser

canHandle, createParserBuilder, doParse, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap

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 OpenApiParser DEFAULT

Reusable instance of OpenApiParser.

Constructor Details

OpenApiParser

public OpenApiParser(OpenApiParser.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static OpenApiParser.Builder create()

Creates a new builder for this object.

Returns:

A new builder.

copy

public OpenApiParser.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 UonParser

Returns:

A new Builder object.

createSession

public OpenApiParserSession.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 UonParser

Returns:

A new session builder.

getSession

public OpenApiParserSession 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 UonParser

Returns:

A new session object.

getPartSession

public OpenApiParserSession getPartSession()

Description copied from interface: HttpPartParser

Creates a new parser session.

Specified by:

getPartSession in interface HttpPartParser

Overrides:

getPartSession in class UonParser

Returns:

A new parser session.

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.

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.

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()

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()