public class OpenApiSerializerBuilder extends UonSerializerBuilder
OpenApiSerializer.psb| Constructor and Description |
|---|
OpenApiSerializerBuilder()
Constructor, default settings.
|
OpenApiSerializerBuilder(PropertyStore ps)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
OpenApiSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
OpenApiSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
OpenApiSerializerBuilder |
addBeanTypes(boolean value)
Configuration property: Add
|
OpenApiSerializerBuilder |
addRootType()
Configuration property: Add type attribute to root nodes.
|
OpenApiSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
OpenApiSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
OpenApiSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
OpenApiSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
OpenApiSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
OpenApiSerializerBuilder |
applyAnnotations(Class<?> fromClass)
Applies any of the various
|
OpenApiSerializerBuilder |
applyAnnotations(Method fromMethod)
Applies any of the various
|
OpenApiSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
OpenApiSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
OpenApiSerializerBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
OpenApiSerializerBuilder |
beanDictionary(Object... values)
Deprecated.
|
OpenApiSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
OpenApiSerializerBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
OpenApiSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
OpenApiSerializerBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
OpenApiSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
OpenApiSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
OpenApiSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
OpenApiSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
OpenApiSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
OpenApiSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
OpenApiSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
OpenApiSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
OpenApiSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
OpenApiSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
OpenApiSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
OpenApiSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
OpenApiSerializerBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
OpenApiSerializerBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
OpenApiSerializerBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
OpenApiSerializerBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
OpenApiSerializerBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
OpenApiSerializerBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
OpenApiSerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
OpenApiSerializerBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
OpenApiSerializerBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
OpenApiSerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
OpenApiSerializerBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
OpenApiSerializerBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
OpenApiSerializer |
build()
Build the object.
|
OpenApiSerializerBuilder |
debug()
Configuration property: Debug mode.
|
OpenApiSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
OpenApiSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
OpenApiSerializerBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
<T> OpenApiSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> OpenApiSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
OpenApiSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
OpenApiSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
OpenApiSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
OpenApiSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
OpenApiSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
OpenApiSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
OpenApiSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
OpenApiSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
OpenApiSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
OpenApiSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
OpenApiSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
OpenApiSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
OpenApiSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
OpenApiSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
OpenApiSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
OpenApiSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
OpenApiSerializerBuilder |
maxDepth(int value)
Configuration property: Max traversal depth.
|
OpenApiSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
OpenApiSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
OpenApiSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
OpenApiSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
OpenApiSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
OpenApiSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
OpenApiSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
OpenApiSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
OpenApiSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
OpenApiSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
OpenApiSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
OpenApiSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
OpenApiSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
OpenApiSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
OpenApiSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
OpenApiSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
OpenApiSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
OpenApiSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
OpenApiSerializerBuilder |
sq()
Configuration property: Quote character.
|
OpenApiSerializerBuilder |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
OpenApiSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
OpenApiSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
OpenApiSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
OpenApiSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
OpenApiSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
OpenApiSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
OpenApiSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
OpenApiSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
OpenApiSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
OpenApiSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
OpenApiSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
OpenApiSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
OpenApiSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
OpenApiSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
OpenApiSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
OpenApiSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
OpenApiSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
OpenApiSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
OpenApiSerializerBuilder |
ws()
Configuration property: Use whitespace.
|
encoding, encoding, paramFormat, paramFormat, paramFormatPlainuriContext, uriRelativity, uriResolutiondebug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamerbuild, getPropertyStore, getPropertyStoreBuilder, peek, peekpublic OpenApiSerializerBuilder()
public OpenApiSerializerBuilder(PropertyStore ps)
ps - The initial configuration settings for this builder.public OpenApiSerializer build()
ContextBuilderbuild in class UonSerializerBuilderpublic OpenApiSerializerBuilder fileCharset(Charset value)
WriterSerializerBuilderThe character set to use for writing Files to the file system.
Used when passing in files to Serializer.serialize(Object, Object).
fileCharset in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder maxIndent(int value)
WriterSerializerBuilderSpecifies the maximum indentation level in the serialized document.
maxIndent in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder quoteChar(char value)
WriterSerializerBuilderThis is the character used for quoting attributes and values.
quoteChar in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(.
sq in class UonSerializerBuilderpublic OpenApiSerializerBuilder streamCharset(Charset value)
WriterSerializerBuilderThe character set to use when writing to OutputStreams.
Used when passing in output streams and byte arrays to Serializer.serialize(Object, Object).
streamCharset in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder useWhitespace(boolean value)
WriterSerializerBuilder
If
useWhitespace in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder useWhitespace()
WriterSerializerBuilder
Shortcut for calling useWhitespace(.
useWhitespace in class UonSerializerBuilderpublic OpenApiSerializerBuilder ws()
WriterSerializerBuilder
Shortcut for calling useWhitespace(.
ws in class UonSerializerBuilderpublic OpenApiSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(.
addBeanTypes in class UonSerializerBuilderpublic OpenApiSerializerBuilder addRootType(boolean value)
SerializerBuilderWhen disabled, it is assumed that the parser knows the exact Java POJO type being parsed, and therefore top-level type information that might normally be included to determine the data type will not be serialized.
addRootType in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(.
addRootType in class UonSerializerBuilderpublic OpenApiSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilderSpecifies that recursions should be checked for during traversal.
detectRecursions in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(.
detectRecursions in class UonSerializerBuilderpublic OpenApiSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(.
ignoreRecursions in class UonSerializerBuilderpublic OpenApiSerializerBuilder initialDepth(int value)
BeanTraverseBuilderThe initial indentation level at the root.
initialDepth in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder listener(Class<? extends SerializerListener> value)
SerializerBuilderClass used to listen for errors and warnings that occur during serialization.
listener in class UonSerializerBuildervalue - The new value for this property.public OpenApiSerializerBuilder maxDepth(int value)
BeanTraverseBuilder
Abort traversal if specified depth is reached in the POJO tree.
If this depth is exceeded, an exception is thrown.
This prevents stack overflows from occurring when trying to traverse models with recursive references.
maxDepth in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder sortCollections(boolean value)
SerializerBuilderCopies and sorts the contents of arrays and collections before serializing them.
sortCollections in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(.
sortCollections in class UonSerializerBuilderpublic OpenApiSerializerBuilder sortMaps(boolean value)
SerializerBuilderCopies and sorts the contents of maps before serializing them.
sortMaps in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(.
sortMaps in class UonSerializerBuilderpublic OpenApiSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(.
trimEmptyCollections in class UonSerializerBuilderpublic OpenApiSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(.
trimEmptyMaps in class UonSerializerBuilderpublic OpenApiSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim() before being serialized.
trimStrings in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(.
trimStrings in class UonSerializerBuilderpublic OpenApiSerializerBuilder uriContext(UriContext value)
SerializerBuilderBean used for resolution of URIs to absolute or root-relative form.
uriContext in class UonSerializerBuildervalue - The new value for this property.public OpenApiSerializerBuilder uriRelativity(UriRelativity value)
SerializerBuilderDefines what relative URIs are relative to when serializing URI/URL objects.
uriRelativity in class UonSerializerBuildervalue - The new value for this property.
UriRelativity.RESOURCEpublic OpenApiSerializerBuilder uriResolution(UriResolution value)
SerializerBuilderDefines the resolution level for URIs when serializing URI/URL objects.
uriResolution in class UonSerializerBuildervalue - The new value for this property.
UriResolution.NONEpublic OpenApiSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilderClasses are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility in class UonSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public OpenApiSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilderOnly look for constructors with the specified minimum visibility.
beanConstructorVisibility in class UonSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.@Deprecated public OpenApiSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
beanDictionary in class UonSerializerBuildervalues - The values to add to this property.@Deprecated public OpenApiSerializerBuilder beanDictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary in class UonSerializerBuildervalues - The values to add to this property.@Deprecated public OpenApiSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class UonSerializerBuildervalues - The new values for this property.@Deprecated public OpenApiSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
beanDictionaryReplace in class UonSerializerBuildervalues - The new values for this property.@Deprecated public OpenApiSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class UonSerializerBuildervalues - The values to remove from this property.@Deprecated public OpenApiSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove in class UonSerializerBuildervalues - The values to remove from this property.public OpenApiSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilderOnly look for bean fields with the specified minimum visibility.
beanFieldVisibility in class UonSerializerBuildervalue - The new value for this property.
Visibility.PUBLIC.public OpenApiSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but takes in an array of classes.
beanFilters in class UonSerializerBuildervalues - The values to add to this property.public OpenApiSerializerBuilder beanFilters(Object... values)
BeanContextBuilder
This is a programmatic equivalent to the @Bean annotation.
It's useful when you want to use the Bean annotation functionality, but you don't have the ability to alter
the bean classes.
beanFilters in class UonSerializerBuildervalues - The values to add to this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public OpenApiSerializerBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but replaces the existing values.
beanFiltersReplace in class UonSerializerBuildervalues - The new values for this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public OpenApiSerializerBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...) but replaces the existing values.
beanFiltersReplace in class UonSerializerBuildervalues - The new values for this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public OpenApiSerializerBuilder beanFiltersRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class UonSerializerBuildervalues - The values to remove from this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public OpenApiSerializerBuilder beanFiltersRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove in class UonSerializerBuildervalues - The values to remove from this property.
@Bean(typeName).
BeanDictionaryList containing a collection of bean classes with type name annotations.
BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
public OpenApiSerializerBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put() method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(.
beanMapPutReturnsOldValue in class UonSerializerBuilderpublic OpenApiSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilderOnly look for bean methods with the specified minimum visibility.
beanMethodVisibility in class UonSerializerBuildervalue - The new value for this property.
Visibility.PUBLICpublic OpenApiSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireDefaultConstructor in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(.
beansRequireDefaultConstructor in class UonSerializerBuilderpublic OpenApiSerializerBuilder beansRequireSerializable(boolean value)
BeanContextBuilder
If Serializable interface to be considered a bean.
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireSerializable in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(.
beansRequireSerializable in class UonSerializerBuilderpublic OpenApiSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(.
beansRequireSettersForGetters in class UonSerializerBuilderpublic OpenApiSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString() method.
beansRequireSomeProperties in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder beanTypePropertyName(String value)
BeanContextBuilderThis specifies the name of the bean property used to store the dictionary name of a bean type so that the parser knows the data type to reconstruct.
beanTypePropertyName in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class UonSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public OpenApiSerializerBuilder bpi(Map<String,String> values)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class UonSerializerBuildervalues - The new value for this property.public OpenApiSerializerBuilder bpi(String beanClassName, String value)
BeanContextBuilderSpecifies the set and order of names of properties associated with the bean class.
bpi in class UonSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public OpenApiSerializerBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean class.
bpx in class UonSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public OpenApiSerializerBuilder bpx(Map<String,String> values)
BeanContextBuilderSpecifies to exclude the specified list of properties for the specified bean classes.
bpx in class UonSerializerBuildervalues - The new value for this property.public OpenApiSerializerBuilder bpx(String beanClassName, String value)
BeanContextBuilderbpx in class UonSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public OpenApiSerializerBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class UonSerializerBuilderbeanClass - The bean class.value - Comma-delimited list of property names.public OpenApiSerializerBuilder bpro(Map<String,String> values)
BeanContextBuilderSpecifies the read-only properties for the specified bean classes.
bpro in class UonSerializerBuildervalues - The new value for this property.public OpenApiSerializerBuilder bpro(String beanClassName, String value)
BeanContextBuilderSpecifies the read-only properties for the specified bean class.
bpro in class UonSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public OpenApiSerializerBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class UonSerializerBuilderbeanClass - The bean class.properties - Comma-delimited list of property names.public OpenApiSerializerBuilder bpwo(Map<String,String> values)
BeanContextBuilderSpecifies the write-only properties for the specified bean classes.
bpwo in class UonSerializerBuildervalues - The new value for this property.public OpenApiSerializerBuilder bpwo(String beanClassName, String value)
BeanContextBuilderSpecifies the write-only properties for the specified bean class.
bpwo in class UonSerializerBuilderbeanClassName - The bean class name.
value - Comma-delimited list of property names.public OpenApiSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(.
debug in class UonSerializerBuilderpublic OpenApiSerializerBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
dictionary in class UonSerializerBuildervalues - The values to add to this property.public OpenApiSerializerBuilder dictionary(Object... values)
BeanContextBuilderAdds to the list of classes that make up the bean dictionary in this bean context.
dictionary in class UonSerializerBuildervalues - The values to add to this property.public OpenApiSerializerBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class UonSerializerBuildervalues - The new values for this property.public OpenApiSerializerBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...) but replaces the existing value.
dictionaryReplace in class UonSerializerBuildervalues - The new values for this property.public OpenApiSerializerBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class UonSerializerBuildervalues - The values to remove from this property.public OpenApiSerializerBuilder dictionaryRemove(Object... values)
BeanContextBuilderRemoves from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove in class UonSerializerBuildervalues - The values to remove from this property.public <T> OpenApiSerializerBuilder example(Class<T> c, T o)
BeanContextBuilderSpecifies an example of the specified class.
example in class UonSerializerBuilderc - The POJO class.o - An instance of the POJO class used for examples.public <T> OpenApiSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilderSpecifies an example of the specified class.
exampleJson in class UonSerializerBuilderT - The POJO class type.c - The POJO class.value - The simple JSON representation of the example.public OpenApiSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnGetters in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(.
ignoreInvocationExceptionsOnGetters in class UonSerializerBuilderpublic OpenApiSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreInvocationExceptionsOnSetters in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(.
ignoreInvocationExceptionsOnSetters in class UonSerializerBuilderpublic OpenApiSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignorePropertiesWithoutSetters in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownBeanProperties in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(.
ignoreUnknownBeanProperties in class UonSerializerBuilderpublic OpenApiSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException is thrown.
ignoreUnknownNullBeanProperties in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilderimplClass in class UonSerializerBuilderinterfaceClass - The interface class.implClass - The implementation class.public OpenApiSerializerBuilder implClasses(Map<String,Class<?>> values)
BeanContextBuilderFor interfaces and abstract classes this method can be used to specify an implementation class for the interface/abstract class so that instances of the implementation class are used when instantiated (e.g. during a parse).
implClasses in class UonSerializerBuildervalues - The new value for this property.public OpenApiSerializerBuilder locale(Locale value)
BeanContextBuilderSpecifies a default locale for serializer and parser sessions.
locale in class UonSerializerBuildervalue - The new value for this property.public OpenApiSerializerBuilder mediaType(MediaType value)
BeanContextBuilderSpecifies a default media type value for serializer and parser sessions.
mediaType in class UonSerializerBuildervalue - The new value for this property.public OpenApiSerializerBuilder notBeanClasses(Class<?>... values)
BeanContextBuilder
List of classes that should not be treated as beans even if they appear to be bean-like.
Not-bean classes are converted to
notBeanClasses in class UonSerializerBuildervalues - The values to add to this property.public OpenApiSerializerBuilder notBeanClasses(Object... values)
BeanContextBuilder
List of classes that should not be treated as beans even if they appear to be bean-like.
Not-bean classes are converted to
notBeanClasses in class UonSerializerBuildervalues - The values to add to this property.
public OpenApiSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class UonSerializerBuildervalues - The new value for this property.public OpenApiSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace in class UonSerializerBuildervalues - The new value for this property.
public OpenApiSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuildernotBeanClassesRemove in class UonSerializerBuildervalues - The values to remove from this property.public OpenApiSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuildernotBeanClassesRemove in class UonSerializerBuildervalues - The values to remove from this property.
public OpenApiSerializerBuilder notBeanPackages(Object... values)
BeanContextBuildernotBeanPackages in class UonSerializerBuildervalues - The values to add to this property.
public OpenApiSerializerBuilder notBeanPackages(String... values)
BeanContextBuildernotBeanPackages in class UonSerializerBuildervalues - The values to add to this property.public OpenApiSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuildernotBeanPackagesReplace in class UonSerializerBuildervalues - public OpenApiSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuildernotBeanPackagesReplace in class UonSerializerBuildervalues - public OpenApiSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuildernotBeanPackagesRemove in class UonSerializerBuildervalues - The values to remove from this property.public OpenApiSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuildernotBeanPackagesRemove in class UonSerializerBuildervalues - public OpenApiSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilderpojoSwaps in class UonSerializerBuildervalues - The values to add to this property.public OpenApiSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilderpojoSwaps in class UonSerializerBuildervalues - The values to add to this property.
PojoSwap.
SurrogateSwap.
public OpenApiSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilderpojoSwapsReplace in class UonSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public OpenApiSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilderpojoSwapsReplace in class UonSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public OpenApiSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilderpojoSwapsRemove in class UonSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public OpenApiSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilderpojoSwapsRemove in class UonSerializerBuildervalues - The values to remove from this property.
PojoSwap.
SurrogateSwap.
public OpenApiSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(.
sortProperties in class UonSerializerBuilderpublic OpenApiSerializerBuilder timeZone(TimeZone value)
BeanContextBuildertimeZone in class UonSerializerBuildervalue - The new value for this property.public OpenApiSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class UonSerializerBuildervalue - The property value.public OpenApiSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString().
useEnumNames in class UonSerializerBuilderpublic OpenApiSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler if there is no other way of instantiating them.
useInterfaceProxies in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder useJavaBeanIntrospector(boolean value)
BeanContextBuilderUsing the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
@Bean annotations will be ignored if you enable this setting.
useJavaBeanIntrospector in class UonSerializerBuildervalue - The new value for this property.
public OpenApiSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(.
useJavaBeanIntrospector in class UonSerializerBuilderpublic OpenApiSerializerBuilder set(String name, Object value)
ContextBuilderset in class UonSerializerBuildername - The property name.value - The property value.PropertyStoreBuilder.set(String, Object)public OpenApiSerializerBuilder set(Map<String,Object> properties)
ContextBuilderset in class UonSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)public OpenApiSerializerBuilder add(Map<String,Object> properties)
ContextBuilderadd in class UonSerializerBuilderproperties - The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)public OpenApiSerializerBuilder addTo(String name, Object value)
ContextBuilderaddTo in class UonSerializerBuildername - The property name.value - The new value to add to the SET property.public OpenApiSerializerBuilder addTo(String name, String key, Object value)
ContextBuilderaddTo in class UonSerializerBuildername - The property name.key - The property value map key.value - The property value map value.public OpenApiSerializerBuilder removeFrom(String name, Object value)
ContextBuilderremoveFrom in class UonSerializerBuildername - The property name.value - The property value in the SET property.public OpenApiSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilderapply in class UonSerializerBuildercopyFrom - The factory whose settings are being copied.public OpenApiSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilderapplyAnnotations in class UonSerializerBuilderal - The list of all annotations annotated with PropertyStoreApply.vrs - The string resolver for resolving variables in annotation values.public OpenApiSerializerBuilder applyAnnotations(Class<?> fromClass)
ContextBuilderApplies any of the following annotations:
BeanConfig
CsvConfig
HtmlConfig
HtmlDocConfig
JsoConfig
JsonConfig
JsonSchemaConfig
MsgPackConfig
OpenApiConfig
ParserConfig
PlainTextConfig
SerializerConfig
SoapXmlConfig
UonConfig
UrlEncodingConfig
XmlConfig
Annotations are appended in the following order:
applyAnnotations in class UonSerializerBuilderfromClass - The class on which the annotations are defined.public OpenApiSerializerBuilder applyAnnotations(Method fromMethod)
ContextBuilderApplies any of the following annotations:
BeanConfig
CsvConfig
HtmlConfig
HtmlDocConfig
JsoConfig
JsonConfig
JsonSchemaConfig
MsgPackConfig
OpenApiConfig
ParserConfig
PlainTextConfig
SerializerConfig
SoapXmlConfig
UonConfig
UrlEncodingConfig
XmlConfig
Annotations are appended in the following orders:
applyAnnotations in class UonSerializerBuilderfromMethod - The method on which the annotations are defined.Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.