@ConfigurableContext public class OpenApiParser extends UonParser implements OpenApiMetaProvider, OpenApiCommon
UonParser.Decoding
Parser.Null
HttpPartParser.Null
Modifier and Type | Field and Description |
---|---|
static OpenApiParser |
DEFAULT
Reusable instance of
OpenApiParser . |
DEFAULT_DECODING, UON_decoding, UON_validateEnd
RPARSER_fileCharset, RPARSER_streamCharset
PARSER_autoCloseStreams, PARSER_debugOutputLines, PARSER_listener, PARSER_strict, PARSER_trimStrings, PARSER_unbuffered
BEAN_annotations, BEAN_beanClassVisibility, BEAN_beanConstructorVisibility, BEAN_beanDictionary, BEAN_beanDictionary_add, BEAN_beanDictionary_remove, BEAN_beanFieldVisibility, BEAN_beanFilters, BEAN_beanFilters_add, BEAN_beanFilters_remove, BEAN_beanMapPutReturnsOldValue, BEAN_beanMethodVisibility, BEAN_beansRequireDefaultConstructor, BEAN_beansRequireSerializable, BEAN_beansRequireSettersForGetters, BEAN_beansRequireSomeProperties, BEAN_bpi, BEAN_bpro, BEAN_bpwo, BEAN_bpx, BEAN_examples, BEAN_excludeProperties, BEAN_fluentSetters, BEAN_ignoreInvocationExceptionsOnGetters, BEAN_ignoreInvocationExceptionsOnSetters, BEAN_ignorePropertiesWithoutSetters, BEAN_ignoreTransientFields, BEAN_ignoreUnknownBeanProperties, BEAN_ignoreUnknownNullBeanProperties, BEAN_implClasses, BEAN_includeProperties, BEAN_notBeanClasses, BEAN_notBeanClasses_add, BEAN_notBeanClasses_remove, BEAN_notBeanPackages, BEAN_notBeanPackages_add, BEAN_notBeanPackages_remove, BEAN_pojoSwaps, BEAN_pojoSwaps_add, BEAN_pojoSwaps_remove, BEAN_propertyNamer, BEAN_sortProperties, BEAN_swaps, BEAN_swaps_add, BEAN_swaps_remove, BEAN_typePropertyName, BEAN_useEnumNames, BEAN_useInterfaceProxies, BEAN_useJavaBeanIntrospector, DEFAULT_SORTED
CONTEXT_debug, CONTEXT_locale, CONTEXT_mediaType, CONTEXT_timeZone
OAPI_collectionFormat, OAPI_format
Constructor and Description |
---|
OpenApiParser(PropertyStore ps)
Constructor.
|
OpenApiParser(PropertyStore ps,
String... consumes)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
OpenApiParserBuilder |
builder()
Creates a builder from this context object.
|
static OpenApiParserBuilder |
create()
Instantiates a new clean-slate
OpenApiParserBuilder object. |
OpenApiParserSession |
createPartSession(ParserSessionArgs args)
Creates a new parser session.
|
OpenApiParserSession |
createSession()
Create a new bean session based on the properties defined on this context.
|
OpenApiParserSession |
createSession(ParserSessionArgs args)
Create the session object that will be passed in to the parse method.
|
protected HttpPartCollectionFormat |
getCollectionFormat()
Returns the default collection format to use when not otherwise specified via
Schema.collectionFormat() |
protected 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.
|
OMap |
toMap()
Returns the properties defined on this bean context as a simple map for debugging purposes.
|
createParameterSession, getUonBeanPropertyMeta, getUonClassMeta, isDecoding, isValidateEnd, parse, parse, parse
getFileCharset, getStreamCharset, isReaderParser
canHandle, createDefaultSessionArgs, getDebugOutputLines, getListener, getMediaTypes, getPrimaryMediaType, isAutoCloseStreams, isStrict, isTrimStrings, isUnbuffered, parse, parse, parse, parse, parse, parse, parseArgs, parseIntoCollection, parseIntoMap
_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, createSession, createSession, dumpCacheStats, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getAnnotations, getBeanClassVisibility, getBeanConstructorVisibility, getBeanDictionaryClasses, getBeanFieldVisibility, getBeanFilters, getBeanMeta, getBeanMethodVisibility, getBeanRegistry, getBeanToStringSerializer, getBeanTypePropertyName, getBpi, getBpi, getBpro, getBpro, getBpwo, getBpwo, getBpx, getBpx, getClassMeta, getClassMeta, getClassMetaForObject, getDeclaredAnnotations, getDeclaredAnnotations, getExamples, getImplClassConstructor, getImplClasses, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastAnnotation, getLastDeclaredAnnotation, getLastDeclaredAnnotation, getNotBeanClasses, getNotBeanPackagesNames, getNotBeanPackagesPrefixes, getPropertyNamer, getSwaps, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasSameCache, isBean, isBeanMapPutReturnsOldValue, isBeansRequireDefaultConstructor, isBeansRequireSerializable, isBeansRequireSettersForGetters, isBeansRequireSomeProperties, isFluentSetters, isIgnoreInvocationExceptionsOnGetters, isIgnoreInvocationExceptionsOnSetters, isIgnorePropertiesWithoutSetters, isIgnoreTransientFields, isIgnoreUnknownBeanProperties, isIgnoreUnknownNullBeanProperties, isNotABean, isSortProperties, isUseEnumNames, isUseInterfaceProxies, isUseJavaBeanIntrospector, object, resolveClassMeta, string
equals, getArrayProperty, getArrayProperty, getBooleanProperty, getCdlProperty, getClassArrayProperty, getClassArrayProperty, getClassArrayProperty, getClassListProperty, getClassListProperty, getClassMapProperty, getClassMapProperty, getClassProperty, getClassSetProperty, getClassSetProperty, getDefaultLocale, getDefaultMediaType, getDefaultTimeZone, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceArrayProperty, getInstanceProperty, getInstanceProperty, getInstanceProperty, getIntegerProperty, getListProperty, getListProperty, getLongProperty, getMapProperty, getProperty, getProperty, getPropertyKeys, getPropertyStore, getSetProperty, getSetProperty, getStringProperty, getStringPropertyWithNone, hashCode, identityCode, isDebug, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getAnnotations, getAnnotations, getAnnotations, getAnnotations, getDeclaredAnnotations
getClassMeta, getClassMeta
public static final OpenApiParser DEFAULT
OpenApiParser
.public OpenApiParser(PropertyStore ps)
ps
- The property store containing all the settings for this object.public OpenApiParser(PropertyStore ps, String... consumes)
ps
- The property store containing all the settings for this object.consumes
- The list of media types that this parser consumes (e.g. public OpenApiParserBuilder builder()
Context
Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.
public static OpenApiParserBuilder create()
OpenApiParserBuilder
object.
This is equivalent to simply calling
.
Note that this method creates a builder initialized to all default settings, whereas builder()
copies
the settings of the object called on.
OpenApiParserBuilder
object.public OpenApiParserSession createSession()
BeanContext
Use this method for creating sessions if you don't need to override any properties or locale/timezone currently set on this context.
createSession
in class UonParser
public OpenApiParserSession createSession(ParserSessionArgs args)
Parser
It's up to implementers to decide what the session object looks like, although typically it's going to be a
subclass of ParserSession
.
createSession
in class UonParser
args
- Runtime arguments.public OpenApiParserSession createPartSession(ParserSessionArgs args)
HttpPartParser
createPartSession
in interface HttpPartParser
createPartSession
in class UonParser
args
- The runtime arguments for the session.public OpenApiClassMeta getOpenApiClassMeta(ClassMeta<?> cm)
OpenApiMetaProvider
getOpenApiClassMeta
in interface OpenApiMetaProvider
cm
- The class to return the metadata on.public OpenApiBeanPropertyMeta getOpenApiBeanPropertyMeta(BeanPropertyMeta bpm)
OpenApiMetaProvider
getOpenApiBeanPropertyMeta
in interface OpenApiMetaProvider
bpm
- The bean property to return the metadata on.protected final HttpPartFormat getFormat()
Schema.format()
Schema.format()
protected final HttpPartCollectionFormat getCollectionFormat()
Schema.collectionFormat()
Schema.collectionFormat()
Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.