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 |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
OpenApiSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
OpenApiSerializerBuilder |
beanDictionary(boolean append,
Object... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
beanDictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
beanDictionary(Object... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
beanDictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
OpenApiSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
OpenApiSerializerBuilder |
beanFilters(boolean append,
Object... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
OpenApiSerializerBuilder |
beanFiltersRemove(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.
|
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.
|
<T> OpenApiSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
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.
|
<T> OpenApiSerializerBuilder |
implClass(Class<T> interfaceClass,
Class<? extends T> 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(boolean append,
Object... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
OpenApiSerializerBuilder |
notBeanPackages(boolean append,
Object... values)
Configuration property: Bean package 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 |
pojoSwaps(boolean append,
Object... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
OpenApiSerializerBuilder |
pojoSwapsRemove(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(boolean append,
String name,
Object value)
Sets or adds to a SET or LIST 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 |
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 |
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.
|
abridged, abridged, addBeanTypeProperties, encoding, encoding, paramFormat, paramFormatPlain
uriContext, uriRelativity, uriResolution
debug, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder
public OpenApiSerializerBuilder()
public OpenApiSerializerBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public OpenApiSerializer build()
ContextBuilder
build
in class UonSerializerBuilder
public OpenApiSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(
.
addBeanTypes
in class UonSerializerBuilder
public OpenApiSerializerBuilder addRootType(boolean value)
SerializerBuilder
When 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 UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(
.
addRootType
in class UonSerializerBuilder
public OpenApiSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilder
Specifies that recursions should be checked for during traversal.
detectRecursions
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(
.
detectRecursions
in class UonSerializerBuilder
public OpenApiSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(
.
ignoreRecursions
in class UonSerializerBuilder
public OpenApiSerializerBuilder initialDepth(int value)
BeanTraverseBuilder
The initial indentation level at the root.
initialDepth
in class UonSerializerBuilder
value
- The new value for this property.
0
.public OpenApiSerializerBuilder listener(Class<? extends SerializerListener> value)
SerializerBuilder
Class used to listen for errors and warnings that occur during serialization.
listener
in class UonSerializerBuilder
value
- 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 UonSerializerBuilder
value
- The new value for this property.
100
.public OpenApiSerializerBuilder maxIndent(int value)
WriterSerializerBuilder
Specifies the maximum indentation level in the serialized document.
maxIndent
in class UonSerializerBuilder
value
- The new value for this property.
100
.public OpenApiSerializerBuilder quoteChar(char value)
WriterSerializerBuilder
This is the character used for quoting attributes and values.
quoteChar
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder sortCollections(boolean value)
SerializerBuilder
Copies and sorts the contents of arrays and collections before serializing them.
sortCollections
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(
.
sortCollections
in class UonSerializerBuilder
public OpenApiSerializerBuilder sortMaps(boolean value)
SerializerBuilder
Copies and sorts the contents of maps before serializing them.
sortMaps
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(
.
sortMaps
in class UonSerializerBuilder
public OpenApiSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(
.
sq
in class UonSerializerBuilder
public OpenApiSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(
.
trimEmptyCollections
in class UonSerializerBuilder
public OpenApiSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(
.
trimEmptyMaps
in class UonSerializerBuilder
public OpenApiSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim()
before being serialized.
trimStrings
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(
.
trimStrings
in class UonSerializerBuilder
public OpenApiSerializerBuilder uriContext(UriContext value)
SerializerBuilder
Bean used for resolution of URIs to absolute or root-relative form.
uriContext
in class UonSerializerBuilder
value
- The new value for this property.public OpenApiSerializerBuilder uriRelativity(UriRelativity value)
SerializerBuilder
Defines what relative URIs are relative to when serializing URI/URL objects.
uriRelativity
in class UonSerializerBuilder
value
- The new value for this property.
UriRelativity.RESOURCE
public OpenApiSerializerBuilder uriResolution(UriResolution value)
SerializerBuilder
Defines the resolution level for URIs when serializing URI/URL objects.
uriResolution
in class UonSerializerBuilder
value
- The new value for this property.
UriResolution.NONE
public OpenApiSerializerBuilder useWhitespace(boolean value)
SerializerBuilder
If
useWhitespace
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder useWhitespace()
SerializerBuilder
Shortcut for calling useWhitespace(
.
useWhitespace
in class UonSerializerBuilder
public OpenApiSerializerBuilder ws()
SerializerBuilder
Shortcut for calling useWhitespace(
.
ws
in class UonSerializerBuilder
public OpenApiSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilder
Classes are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is PUBLIC
and the bean class is
beanClassVisibility
in class UonSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public OpenApiSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilder
Only look for constructors with the specified minimum visibility.
beanConstructorVisibility
in class UonSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public OpenApiSerializerBuilder beanDictionary(boolean append, Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but allows you to optionally overwrite the previous value.
beanDictionary
in class UonSerializerBuilder
append
- If values
- The new values for this property.public OpenApiSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
beanDictionary
in class UonSerializerBuilder
values
- The values to add to this property.public OpenApiSerializerBuilder beanDictionary(Object... values)
BeanContextBuilder
Adds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary
in class UonSerializerBuilder
values
- The values to add to this property.public OpenApiSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class UonSerializerBuilder
values
- The values to remove from this property.public OpenApiSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilder
Only look for bean fields with the specified minimum visibility.
beanFieldVisibility
in class UonSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public OpenApiSerializerBuilder beanFilters(boolean append, Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but allows you to optionally overwrite the previous value.
beanFilters
in class UonSerializerBuilder
append
- If values
- 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 beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but takes in an array of classes.
beanFilters
in class UonSerializerBuilder
values
- 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 UonSerializerBuilder
values
- 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 beanFiltersRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class UonSerializerBuilder
values
- 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 UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class UonSerializerBuilder
public OpenApiSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilder
Only look for bean methods with the specified minimum visibility.
beanMethodVisibility
in class UonSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
public OpenApiSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireDefaultConstructor
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class UonSerializerBuilder
public 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 UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class UonSerializerBuilder
public OpenApiSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class UonSerializerBuilder
public OpenApiSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireSomeProperties
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder beanTypePropertyName(String value)
BeanContextBuilder
This 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 UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class UonSerializerBuilder
public <T> OpenApiSerializerBuilder example(Class<T> c, T o)
BeanContextBuilder
Specifies an example of the specified class.
example
in class UonSerializerBuilder
c
- The POJO class.o
- An instance of the POJO class used for examples.public OpenApiSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class UonSerializerBuilder
public OpenApiSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class UonSerializerBuilder
public OpenApiSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class UonSerializerBuilder
public OpenApiSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class UonSerializerBuilder
value
- The new value for this property.
public <T> OpenApiSerializerBuilder implClass(Class<T> interfaceClass, Class<? extends T> implClass)
BeanContextBuilder
implClass
in class UonSerializerBuilder
T
- The class type of the interface.interfaceClass
- The interface class.implClass
- The implementation class.public OpenApiSerializerBuilder implClasses(Map<String,Class<?>> values)
BeanContextBuilder
For 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 UonSerializerBuilder
values
- The new value for this property.public OpenApiSerializerBuilder locale(Locale value)
BeanContextBuilder
Specifies a default locale for serializer and parser sessions.
locale
in class UonSerializerBuilder
value
- The new value for this property.public OpenApiSerializerBuilder mediaType(MediaType value)
BeanContextBuilder
Specifies a default media type value for serializer and parser sessions.
mediaType
in class UonSerializerBuilder
value
- The new value for this property.public OpenApiSerializerBuilder notBeanClasses(boolean append, Object... values)
BeanContextBuilder
Not-bean classes are converted to Strings
during serialization even if they appear to be
bean-like.
notBeanClasses
in class UonSerializerBuilder
append
- If values
- 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 Strings
during serialization.
notBeanClasses
in class UonSerializerBuilder
values
- 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 Strings
during serialization.
notBeanClasses
in class UonSerializerBuilder
values
- The values to add to this property.
public OpenApiSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class UonSerializerBuilder
values
- The values to remove from this property.
public OpenApiSerializerBuilder notBeanPackages(boolean append, Object... values)
BeanContextBuilder
When specified, the current list of ignore packages are appended to.
notBeanPackages
in class UonSerializerBuilder
append
- If values
- The new values for this property.
public OpenApiSerializerBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class UonSerializerBuilder
values
- The values to add to this property.
public OpenApiSerializerBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class UonSerializerBuilder
values
- The values to add to this property.public OpenApiSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class UonSerializerBuilder
values
- public OpenApiSerializerBuilder pojoSwaps(boolean append, Object... values)
BeanContextBuilder
POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization, and "swap in" the non-serializable class during parsing.
An example of a POJO swap would be a Calendar
object that gets swapped out for an ISO8601 string.
pojoSwaps
in class UonSerializerBuilder
append
- If values
- The new value for this property.
public OpenApiSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class UonSerializerBuilder
values
- The values to add to this property.public OpenApiSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class UonSerializerBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public OpenApiSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class UonSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public OpenApiSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class UonSerializerBuilder
public OpenApiSerializerBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class UonSerializerBuilder
value
- The new value for this property.public OpenApiSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class UonSerializerBuilder
public OpenApiSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler
if there is no other way of instantiating them.
useInterfaceProxies
in class UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder useJavaBeanIntrospector(boolean value)
BeanContextBuilder
Using 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 UonSerializerBuilder
value
- The new value for this property.
public OpenApiSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class UonSerializerBuilder
public OpenApiSerializerBuilder set(String name, Object value)
ContextBuilder
set
in class UonSerializerBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public OpenApiSerializerBuilder set(boolean append, String name, Object value)
ContextBuilder
set
in class UonSerializerBuilder
append
- If name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public OpenApiSerializerBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class UonSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public OpenApiSerializerBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class UonSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public OpenApiSerializerBuilder addTo(String name, Object value)
ContextBuilder
addTo
in class UonSerializerBuilder
name
- The property name.value
- The new value to add to the SET property.public OpenApiSerializerBuilder addTo(String name, String key, Object value)
ContextBuilder
addTo
in class UonSerializerBuilder
name
- The property name.key
- The property value map key.value
- The property value map value.public OpenApiSerializerBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class UonSerializerBuilder
name
- The property name.value
- The property value in the SET property.public OpenApiSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class UonSerializerBuilder
copyFrom
- The factory whose settings are being copied.Copyright © 2018 Apache. All rights reserved.