Package org.apache.juneau.oapi

Class OpenApiParserSession

java.lang.Object

org.apache.juneau.ContextSession

org.apache.juneau.BeanSession

org.apache.juneau.parser.ParserSession

org.apache.juneau.parser.ReaderParserSession

org.apache.juneau.uon.UonParserSession

org.apache.juneau.oapi.OpenApiParserSession

All Implemented Interfaces:

HttpPartParserSession

public class OpenApiParserSession
extends UonParserSession

Session object that lives for the duration of a single use of OpenApiParser.

Notes:

• This class is not thread safe and is typically discarded after one use.

See Also:

• OpenApi Basics

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OpenApiParserSession(OpenApiParserSession.Builder builder)	Constructor.

Method Summary

Modifier and Type	Method	Description
static OpenApiParserSession.Builder	create(OpenApiParser ctx)	Creates a new builder for this object.
protected <T> T	doParse(ParserPipe pipe, ClassMeta<T> type)	Workhorse method.
<T> T	parse(HttpPartType partType, HttpPartSchema schema, String in, ClassMeta<T> type)	Converts the specified input to the specified class type.

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

create, doParseIntoCollection, doParseIntoMap, getUonReader, isDecoding, isValidateEnd, parseAnything, parseAttr, parseAttrName, parseString, properties

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

create, createPipe, getFileCharset, getStreamCharset, isReaderParser

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

cast, convertAttrToType, create, getClassMeta, getDebugOutputLines, getInputAsString, getJavaMethod, getLastLocation, getListener, getListener, getListenerClass, getOuter, getPosition, getSchema, getStringBuilder, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, mark, onBeanSetterException, onUnknownProperty, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap, returnStringBuilder, setCurrentClass, setCurrentProperty, setName, setParent, setPipe, trim, trim, unmark, unswap

Methods inherited from class org.apache.juneau.BeanSession

_class, addWarning, convertToMemberType, convertToMemberType, convertToType, convertToType, convertToType, create, getArgsClassMeta, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionary, getBeanFieldVisibility, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanTypePropertyName, getBeanTypePropertyName, getClassMeta, getClassMeta, getClassMetaForObject, getClassMetaForObject, getLocale, getMediaType, getNamePropertyName, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, getTimeZone, getTimeZoneId, isBean, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFindFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnoreMissingSetters, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, newBean, newBean, newBeanMap, newBeanMap, newGenericMap, object, string, toArray, toBeanMap, toBeanMap, toBeanMap

Methods inherited from class org.apache.juneau.ContextSession

checkForWarnings, getContext, getSessionProperties, getWarnings, isDebug, toString

Methods inherited from class java.lang.Object

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

Constructor Details

OpenApiParserSession

protected OpenApiParserSession(OpenApiParserSession.Builder builder)

Constructor.

Parameters:

builder - The builder for this object.

Method Details

create

public static OpenApiParserSession.Builder create(OpenApiParser ctx)

Creates a new builder for this object.

Parameters:

ctx - The context creating this session.

Returns:

A new builder.

parse

public <T> T parse(HttpPartType partType,
 HttpPartSchema schema,
 String in,
 ClassMeta<T> type)
            throws ParseException,
SchemaValidationException

Description copied from interface: HttpPartParserSession

Converts the specified input to the specified class type.

Specified by:

parse in interface HttpPartParserSession

Overrides:

parse in class UonParserSession

Type Parameters:

T - The POJO type to transform the input into.

Parameters:

partType - The part type being parsed.

schema - Schema information about the part.
May be null.
Not all part parsers use the schema information.

in - The input being parsed.

type - The POJO type to transform the input into.

Returns:

The parsed value.

Throws:

ParseException - Malformed input encountered.

SchemaValidationException - If the input or resulting HTTP part object fails schema validation.

doParse

protected <T> T doParse(ParserPipe pipe,
 ClassMeta<T> type)
                 throws IOException,
ParseException,
ExecutableException

Description copied from class: ParserSession

Workhorse method.

Subclasses are expected to implement this method or Parser.doParse(ParserSession,ParserPipe,ClassMeta).

The default implementation of this method simply calls Parser.doParse(ParserSession,ParserPipe,ClassMeta).

Overrides:

doParse in class UonParserSession

Type Parameters:

T - The class type of the object to create.

Parameters:

pipe - Where to get the input from.

type - The class type of the object to create. If null or Object.class, object type is based on what's being parsed. For example, when parsing JSON text, it may return a String, Number, JsonMap, etc...

Returns:

The parsed object.

Throws:

IOException - Thrown by underlying stream.

ParseException - Malformed input encountered.

ExecutableException - Exception occurred on invoked constructor/method/field.