@ConfigurableContext public class OpenApiSerializer extends UonSerializer implements OpenApiMetaProvider, OpenApiCommon
UonSerializer.Encoding, UonSerializer.Readable
Serializer.Null
HttpPartSerializer.Null
Modifier and Type | Field and Description |
---|---|
static OpenApiSerializer |
DEFAULT
Reusable instance of
OpenApiSerializer , all default settings. |
DEFAULT_ENCODING, DEFAULT_READABLE, UON_addBeanTypes, UON_encoding, UON_paramFormat
WSERIALIZER_fileCharset, WSERIALIZER_maxIndent, WSERIALIZER_quoteChar, WSERIALIZER_streamCharset, WSERIALIZER_useWhitespace
SERIALIZER_addBeanTypes, SERIALIZER_addRootType, SERIALIZER_keepNullProperties, SERIALIZER_listener, SERIALIZER_sortCollections, SERIALIZER_sortMaps, SERIALIZER_trimEmptyCollections, SERIALIZER_trimEmptyMaps, SERIALIZER_trimNullProperties, SERIALIZER_trimStrings, SERIALIZER_uriContext, SERIALIZER_uriRelativity, SERIALIZER_uriResolution
BEANTRAVERSE_detectRecursions, BEANTRAVERSE_ignoreRecursions, BEANTRAVERSE_initialDepth, BEANTRAVERSE_maxDepth
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 |
---|
OpenApiSerializer(PropertyStore ps)
Constructor.
|
OpenApiSerializer(PropertyStore ps,
String produces,
String accept)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
OpenApiSerializerBuilder |
builder()
Creates a builder from this context object.
|
static OpenApiSerializerBuilder |
create()
Instantiates a new clean-slate
OpenApiSerializerBuilder object. |
OpenApiSerializerSession |
createPartSession(SerializerSessionArgs args)
Creates a new serializer session.
|
OpenApiSerializerSession |
createSession()
Create a new bean session based on the properties defined on this context.
|
OpenApiSerializerSession |
createSession(SerializerSessionArgs args)
Create the session object used for actual serialization of objects.
|
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.
|
getParamFormat, getQuoteChar, getUonBeanPropertyMeta, getUonClassMeta, isAddBeanTypes, isEncoding, serialize
getFileCharset, getMaxIndent, getStreamCharset, isUseWhitespace, isWriterSerializer, println, serialize, toString, toStringObject
createDefaultSessionArgs, getAcceptMediaTypes, getListener, getMediaTypeRanges, getPrimaryMediaType, getResponseContentType, getUriContext, getUriRelativity, getUriResolution, isAddRootType, isKeepNullProperties, isSortCollections, isSortMaps, isTrimEmptyCollections, isTrimEmptyMaps, isTrimStrings, serialize, serializeToString
createSession, getInitialDepth, getMaxDepth, isDetectRecursions, isIgnoreRecursions
_class, createBeanSession, createBeanSession, createDefaultBeanSessionArgs, 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
public static final OpenApiSerializer DEFAULT
OpenApiSerializer
, all default settings.public OpenApiSerializer(PropertyStore ps, String produces, String accept)
ps
- The property store containing all the settings for this object.produces
- The media type that this serializer produces.accept
- The accept media types that the serializer can handle.
Can contain meta-characters per the
If empty, then assumes the only media type supported is
For example, if this serializer produces
The accept value can also contain q-values.
public OpenApiSerializer(PropertyStore ps)
ps
- The property store containing all the settings for this object.public OpenApiSerializerBuilder builder()
Context
Builders are used to define new contexts (e.g. serializers, parsers) based on existing configurations.
builder
in class UonSerializer
public static OpenApiSerializerBuilder create()
OpenApiSerializerBuilder
object.
Note that this method creates a builder initialized to all default settings, whereas builder()
copies
the settings of the object called on.
OpenApiSerializerBuilder
object.public OpenApiSerializerSession 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 UonSerializer
public OpenApiSerializerSession createSession(SerializerSessionArgs args)
Serializer
createSession
in class UonSerializer
args
- Runtime arguments.
These specify session-level information such as locale and URI context.
It also include session-level properties that override the properties defined on the bean and serializer
contexts.public OpenApiSerializerSession createPartSession(SerializerSessionArgs args)
HttpPartSerializer
createPartSession
in interface HttpPartSerializer
createPartSession
in class UonSerializer
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()
public OMap toMap()
Context
toMap
in class UonSerializer
Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.