public class WriterSerializerBuilder extends SerializerBuilder
psb
Constructor and Description |
---|
WriterSerializerBuilder()
Constructor, default settings.
|
WriterSerializerBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
WriterSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
WriterSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
WriterSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
WriterSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
WriterSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
WriterSerializerBuilder |
applyAnnotations(Class<?> fromClass)
Applies any of the various
|
WriterSerializerBuilder |
applyAnnotations(Method fromMethod)
Applies any of the various
|
WriterSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
WriterSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
WriterSerializerBuilder |
beanDictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
WriterSerializerBuilder |
beanDictionary(Object... values)
Configuration property: Bean dictionary.
|
WriterSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
WriterSerializerBuilder |
beanDictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
WriterSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
WriterSerializerBuilder |
beanDictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
WriterSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
WriterSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
WriterSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
WriterSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
WriterSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
WriterSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
WriterSerializerBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
WriterSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
WriterSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
WriterSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
WriterSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
WriterSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
WriterSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
WriterSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
WriterSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
WriterSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
WriterSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
WriterSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
WriterSerializer |
build()
Build the object.
|
WriterSerializerBuilder |
debug()
Configuration property: Debug mode.
|
<T> WriterSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> WriterSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
WriterSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
WriterSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
WriterSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
WriterSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
WriterSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
WriterSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
WriterSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
WriterSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
WriterSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
WriterSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
WriterSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
WriterSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
WriterSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
WriterSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
WriterSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
WriterSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
WriterSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
WriterSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
WriterSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
WriterSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
WriterSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
WriterSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
WriterSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
WriterSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
WriterSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
WriterSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
WriterSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
WriterSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
WriterSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
WriterSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
WriterSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
WriterSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
WriterSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
WriterSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
WriterSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
WriterSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
WriterSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
WriterSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
WriterSerializerBuilder |
sq()
Configuration property: Quote character.
|
WriterSerializerBuilder |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
WriterSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
WriterSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
WriterSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
WriterSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
WriterSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
WriterSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
WriterSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
WriterSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
SerializerBuilder |
ws()
Configuration property: Use whitespace.
|
addBeanTypes, addBeanTypes, addRootType, addRootType, detectRecursions, detectRecursions, ignoreRecursions, ignoreRecursions, initialDepth, listener, maxDepth, sortCollections, sortCollections, sortMaps, sortMaps, trimEmptyCollections, trimEmptyCollections, trimEmptyMaps, trimEmptyMaps, trimNullProperties, trimStrings, trimStrings, uriContext, uriContext, uriRelativity, uriRelativity, uriResolution, uriResolution
debug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder, peek, peek
public WriterSerializerBuilder()
public WriterSerializerBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public WriterSerializerBuilder fileCharset(Charset value)
The character set to use for writing Files to the file system.
Used when passing in files to Serializer.serialize(Object, Object)
.
value
- The new value for this property.
public WriterSerializerBuilder maxIndent(int value)
Specifies the maximum indentation level in the serialized document.
value
- The new value for this property.
public WriterSerializerBuilder quoteChar(char value)
This is the character used for quoting attributes and values.
value
- The new value for this property.
public WriterSerializerBuilder sq()
Shortcut for calling quoteChar(
.
public WriterSerializerBuilder streamCharset(Charset value)
The character set to use when writing to OutputStreams.
Used when passing in output streams and byte arrays to Serializer.serialize(Object, Object)
.
value
- The new value for this property.
public WriterSerializerBuilder useWhitespace(boolean value)
If
value
- The new value for this property.
public WriterSerializerBuilder useWhitespace()
Shortcut for calling useWhitespace(
.
public SerializerBuilder ws()
Shortcut for calling useWhitespace(
.
public WriterSerializerBuilder beanClassVisibility(Visibility value)
BeanContextBuilder
Classes are not considered beans unless they meet the minimum visibility requirements.
For example, if the visibility is
beanClassVisibility
in class SerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public WriterSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilder
Only look for constructors with the specified minimum visibility.
beanConstructorVisibility
in class SerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public WriterSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
beanDictionary
in class SerializerBuilder
values
- The values to add to this property.public WriterSerializerBuilder beanDictionary(Object... values)
BeanContextBuilder
Adds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary
in class SerializerBuilder
values
- The values to add to this property.public WriterSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class SerializerBuilder
values
- The new values for this property.public WriterSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class SerializerBuilder
values
- The new values for this property.public WriterSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class SerializerBuilder
values
- The values to remove from this property.public WriterSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class SerializerBuilder
values
- The values to remove from this property.public WriterSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilder
Only look for bean fields with the specified minimum visibility.
beanFieldVisibility
in class SerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public WriterSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but takes in an array of classes.
beanFilters
in class SerializerBuilder
values
- The values to add to this property.public WriterSerializerBuilder 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 SerializerBuilder
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 WriterSerializerBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class SerializerBuilder
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 WriterSerializerBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class SerializerBuilder
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 WriterSerializerBuilder beanFiltersRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class SerializerBuilder
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 WriterSerializerBuilder beanFiltersRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class SerializerBuilder
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 WriterSerializerBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put()
method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class SerializerBuilder
public WriterSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilder
Only look for bean methods with the specified minimum visibility.
beanMethodVisibility
in class SerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
public WriterSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireDefaultConstructor
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class SerializerBuilder
public WriterSerializerBuilder 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 SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class SerializerBuilder
public WriterSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class SerializerBuilder
public WriterSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireSomeProperties
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder 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 SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class SerializerBuilder
public <T> WriterSerializerBuilder example(Class<T> c, T o)
BeanContextBuilder
Specifies an example of the specified class.
example
in class SerializerBuilder
c
- The POJO class.o
- An instance of the POJO class used for examples.public <T> WriterSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilder
Specifies an example of the specified class.
exampleJson
in class SerializerBuilder
T
- The POJO class type.c
- The POJO class.value
- The simple JSON representation of the example.public WriterSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class SerializerBuilder
public WriterSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class SerializerBuilder
public WriterSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class SerializerBuilder
public WriterSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilder
implClass
in class SerializerBuilder
interfaceClass
- The interface class.implClass
- The implementation class.public WriterSerializerBuilder 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 SerializerBuilder
values
- The new value for this property.public WriterSerializerBuilder locale(Locale value)
BeanContextBuilder
Specifies a default locale for serializer and parser sessions.
locale
in class SerializerBuilder
value
- The new value for this property.public WriterSerializerBuilder mediaType(MediaType value)
BeanContextBuilder
Specifies a default media type value for serializer and parser sessions.
mediaType
in class SerializerBuilder
value
- The new value for this property.public WriterSerializerBuilder 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 SerializerBuilder
values
- The values to add to this property.public WriterSerializerBuilder 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 SerializerBuilder
values
- The values to add to this property.
public WriterSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class SerializerBuilder
values
- The new value for this property.public WriterSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class SerializerBuilder
values
- The new value for this property.
public WriterSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuilder
notBeanClassesRemove
in class SerializerBuilder
values
- The values to remove from this property.public WriterSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class SerializerBuilder
values
- The values to remove from this property.
public WriterSerializerBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class SerializerBuilder
values
- The values to add to this property.
public WriterSerializerBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class SerializerBuilder
values
- The values to add to this property.public WriterSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuilder
notBeanPackagesReplace
in class SerializerBuilder
values
- public WriterSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuilder
notBeanPackagesReplace
in class SerializerBuilder
values
- public WriterSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuilder
notBeanPackagesRemove
in class SerializerBuilder
values
- The values to remove from this property.public WriterSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class SerializerBuilder
values
- public WriterSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class SerializerBuilder
values
- The values to add to this property.public WriterSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class SerializerBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public WriterSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilder
pojoSwapsReplace
in class SerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public WriterSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilder
pojoSwapsReplace
in class SerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public WriterSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilder
pojoSwapsRemove
in class SerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public WriterSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class SerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public WriterSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class SerializerBuilder
public WriterSerializerBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class SerializerBuilder
value
- The new value for this property.public WriterSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class SerializerBuilder
value
- The property value.public WriterSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class SerializerBuilder
public WriterSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler
if there is no other way of instantiating them.
useInterfaceProxies
in class SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder 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 SerializerBuilder
value
- The new value for this property.
public WriterSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class SerializerBuilder
public WriterSerializerBuilder set(String name, Object value)
ContextBuilder
set
in class SerializerBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public WriterSerializerBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class SerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public WriterSerializerBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class SerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public WriterSerializerBuilder addTo(String name, Object value)
ContextBuilder
addTo
in class SerializerBuilder
name
- The property name.value
- The new value to add to the SET property.public WriterSerializerBuilder addTo(String name, String key, Object value)
ContextBuilder
addTo
in class SerializerBuilder
name
- The property name.key
- The property value map key.value
- The property value map value.public WriterSerializerBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class SerializerBuilder
name
- The property name.value
- The property value in the SET property.public WriterSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class SerializerBuilder
copyFrom
- The factory whose settings are being copied.public WriterSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilder
applyAnnotations
in class SerializerBuilder
al
- The list of all annotations annotated with PropertyStoreApply
.vrs
- The string resolver for resolving variables in annotation values.public WriterSerializerBuilder applyAnnotations(Class<?> fromClass)
ContextBuilder
Applies 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 SerializerBuilder
fromClass
- The class on which the annotations are defined.public WriterSerializerBuilder applyAnnotations(Method fromMethod)
ContextBuilder
Applies 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 SerializerBuilder
fromMethod
- The method on which the annotations are defined.public WriterSerializer build()
ContextBuilder
build
in class SerializerBuilder
Copyright © 2016–2019 The Apache Software Foundation. All rights reserved.