public class PlainTextSerializerBuilder extends WriterSerializerBuilder
psb
Constructor and Description |
---|
PlainTextSerializerBuilder()
Constructor, default settings.
|
PlainTextSerializerBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
PlainTextSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
PlainTextSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
PlainTextSerializerBuilder |
addBeanTypes(boolean value)
Configuration property: Add
|
PlainTextSerializerBuilder |
addRootType()
Configuration property: Add type attribute to root nodes.
|
PlainTextSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
PlainTextSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
PlainTextSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
PlainTextSerializerBuilder |
annotations(Annotation... values)
Configuration property: Annotations.
|
PlainTextSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
PlainTextSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
PlainTextSerializerBuilder |
applyAnnotations(Class<?>... fromClasses)
Applies any of the various
|
PlainTextSerializerBuilder |
applyAnnotations(Method... fromMethods)
Applies any of the various
|
PlainTextSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
PlainTextSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
PlainTextSerializerBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
PlainTextSerializerBuilder |
beanDictionary(Object... values)
Deprecated.
|
PlainTextSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
PlainTextSerializerBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
PlainTextSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
PlainTextSerializerBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
PlainTextSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
PlainTextSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
PlainTextSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
PlainTextSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
PlainTextSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
PlainTextSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
PlainTextSerializerBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
PlainTextSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
PlainTextSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
PlainTextSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
PlainTextSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
PlainTextSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
PlainTextSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
PlainTextSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
PlainTextSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
PlainTextSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
PlainTextSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
PlainTextSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
PlainTextSerializerBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
PlainTextSerializerBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
PlainTextSerializerBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
PlainTextSerializerBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
PlainTextSerializerBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
PlainTextSerializerBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
PlainTextSerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
PlainTextSerializerBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
PlainTextSerializerBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
PlainTextSerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
PlainTextSerializerBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
PlainTextSerializerBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
PlainTextSerializer |
build()
Build the object.
|
PlainTextSerializerBuilder |
debug()
Configuration property: Debug mode.
|
PlainTextSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
PlainTextSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
PlainTextSerializerBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
PlainTextSerializerBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
PlainTextSerializerBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
PlainTextSerializerBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
PlainTextSerializerBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
PlainTextSerializerBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
<T> PlainTextSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> PlainTextSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
PlainTextSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
PlainTextSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
PlainTextSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
PlainTextSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
PlainTextSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
PlainTextSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
PlainTextSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
PlainTextSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
PlainTextSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
PlainTextSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
PlainTextSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
PlainTextSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
PlainTextSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
PlainTextSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
PlainTextSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
PlainTextSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
PlainTextSerializerBuilder |
maxDepth(int value)
Configuration property: Max traversal depth.
|
PlainTextSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
PlainTextSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
PlainTextSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
PlainTextSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
PlainTextSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
PlainTextSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
PlainTextSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
PlainTextSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
PlainTextSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
PlainTextSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
PlainTextSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
PlainTextSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
PlainTextSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
PlainTextSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
PlainTextSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
PlainTextSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
PlainTextSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
PlainTextSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
PlainTextSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
PlainTextSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
PlainTextSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
PlainTextSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
PlainTextSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
PlainTextSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
PlainTextSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
PlainTextSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
PlainTextSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
PlainTextSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
PlainTextSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
PlainTextSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
PlainTextSerializerBuilder |
sq()
Configuration property: Quote character.
|
PlainTextSerializerBuilder |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
PlainTextSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
PlainTextSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
PlainTextSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
PlainTextSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
PlainTextSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
PlainTextSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
PlainTextSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
PlainTextSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
PlainTextSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
PlainTextSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
PlainTextSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
PlainTextSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
PlainTextSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
PlainTextSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
PlainTextSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
PlainTextSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
PlainTextSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
PlainTextSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
PlainTextSerializerBuilder |
ws()
Configuration property: Use whitespace.
|
uriContext, uriRelativity, uriResolution
debug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder, peek, peek
public PlainTextSerializerBuilder()
public PlainTextSerializerBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public PlainTextSerializer build()
ContextBuilder
build
in class WriterSerializerBuilder
public PlainTextSerializerBuilder fileCharset(Charset value)
WriterSerializerBuilder
The character set to use for writing Files to the file system.
Used when passing in files to Serializer.serialize(Object, Object)
.
fileCharset
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder maxIndent(int value)
WriterSerializerBuilder
Specifies the maximum indentation level in the serialized document.
maxIndent
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder quoteChar(char value)
WriterSerializerBuilder
This is the character used for quoting attributes and values.
quoteChar
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(
.
sq
in class WriterSerializerBuilder
public PlainTextSerializerBuilder streamCharset(Charset value)
WriterSerializerBuilder
The 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 WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder useWhitespace(boolean value)
WriterSerializerBuilder
If
useWhitespace
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder useWhitespace()
WriterSerializerBuilder
Shortcut for calling useWhitespace(
.
useWhitespace
in class WriterSerializerBuilder
public PlainTextSerializerBuilder ws()
WriterSerializerBuilder
Shortcut for calling useWhitespace(
.
ws
in class WriterSerializerBuilder
public PlainTextSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(
.
addBeanTypes
in class SerializerBuilder
public PlainTextSerializerBuilder 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 SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(
.
addRootType
in class SerializerBuilder
public PlainTextSerializerBuilder detectRecursions(boolean value)
BeanTraverseBuilder
Specifies that recursions should be checked for during traversal.
detectRecursions
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(
.
detectRecursions
in class SerializerBuilder
public PlainTextSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(
.
ignoreRecursions
in class SerializerBuilder
public PlainTextSerializerBuilder initialDepth(int value)
BeanTraverseBuilder
The initial indentation level at the root.
initialDepth
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder listener(Class<? extends SerializerListener> value)
SerializerBuilder
Class used to listen for errors and warnings that occur during serialization.
listener
in class SerializerBuilder
value
- The new value for this property.public PlainTextSerializerBuilder 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 SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder sortCollections(boolean value)
SerializerBuilder
Copies and sorts the contents of arrays and collections before serializing them.
sortCollections
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(
.
sortCollections
in class SerializerBuilder
public PlainTextSerializerBuilder sortMaps(boolean value)
SerializerBuilder
Copies and sorts the contents of maps before serializing them.
sortMaps
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(
.
sortMaps
in class SerializerBuilder
public PlainTextSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(
.
trimEmptyCollections
in class SerializerBuilder
public PlainTextSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(
.
trimEmptyMaps
in class SerializerBuilder
public PlainTextSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim()
before being serialized.
trimStrings
in class SerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(
.
trimStrings
in class SerializerBuilder
public PlainTextSerializerBuilder uriContext(UriContext value)
SerializerBuilder
Bean used for resolution of URIs to absolute or root-relative form.
uriContext
in class SerializerBuilder
value
- The new value for this property.public PlainTextSerializerBuilder uriRelativity(UriRelativity value)
SerializerBuilder
Defines what relative URIs are relative to when serializing URI/URL objects.
uriRelativity
in class SerializerBuilder
value
- The new value for this property.
UriRelativity.RESOURCE
public PlainTextSerializerBuilder uriResolution(UriResolution value)
SerializerBuilder
Defines the resolution level for URIs when serializing URI/URL objects.
uriResolution
in class SerializerBuilder
value
- The new value for this property.
UriResolution.NONE
public PlainTextSerializerBuilder annotations(Annotation... values)
BeanContextBuilder
Defines annotations to apply to specific classes and methods.
Allows you to dynamically apply Juneau annotations typically applied directly to classes and methods. Useful in cases where you want to use the functionality of the annotation on beans and bean properties but do not have access to the code to do so.
annotations
in class WriterSerializerBuilder
values
- The values to add to this property.public PlainTextSerializerBuilder 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 WriterSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public PlainTextSerializerBuilder beanConstructorVisibility(Visibility value)
BeanContextBuilder
Only look for constructors with the specified minimum visibility.
beanConstructorVisibility
in class WriterSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.@Deprecated public PlainTextSerializerBuilder beanDictionary(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionary(Class...)
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
beanDictionary
in class WriterSerializerBuilder
values
- The values to add to this property.@Deprecated public PlainTextSerializerBuilder beanDictionary(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionary(Object...)
Adds to the list of classes that make up the bean dictionary in this bean context.
beanDictionary
in class WriterSerializerBuilder
values
- The values to add to this property.@Deprecated public PlainTextSerializerBuilder beanDictionaryReplace(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionaryReplace(Class...)
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class WriterSerializerBuilder
values
- The new values for this property.@Deprecated public PlainTextSerializerBuilder beanDictionaryReplace(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionaryReplace(Object...)
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
beanDictionaryReplace
in class WriterSerializerBuilder
values
- The new values for this property.@Deprecated public PlainTextSerializerBuilder beanDictionaryRemove(Class<?>... values)
BeanContextBuilder
BeanContextBuilder.dictionaryRemove(Class...)
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.@Deprecated public PlainTextSerializerBuilder beanDictionaryRemove(Object... values)
BeanContextBuilder
BeanContextBuilder.dictionaryRemove(Object...)
Removes from the list of classes that make up the bean dictionary in this bean context.
beanDictionaryRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.public PlainTextSerializerBuilder beanFieldVisibility(Visibility value)
BeanContextBuilder
Only look for bean fields with the specified minimum visibility.
beanFieldVisibility
in class WriterSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
.public PlainTextSerializerBuilder beanFilters(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but takes in an array of classes.
beanFilters
in class WriterSerializerBuilder
values
- The values to add to this property.public PlainTextSerializerBuilder 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 WriterSerializerBuilder
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 PlainTextSerializerBuilder beanFiltersReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class WriterSerializerBuilder
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 PlainTextSerializerBuilder beanFiltersReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanFilters(Object...)
but replaces the existing values.
beanFiltersReplace
in class WriterSerializerBuilder
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 PlainTextSerializerBuilder beanFiltersRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class WriterSerializerBuilder
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 PlainTextSerializerBuilder beanFiltersRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean filters in this bean context.
beanFiltersRemove
in class WriterSerializerBuilder
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 PlainTextSerializerBuilder beanMapPutReturnsOldValue(boolean value)
BeanContextBuilder
If BeanMap.put()
method will return old property
values.
Otherwise, it returns
beanMapPutReturnsOldValue
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class WriterSerializerBuilder
public PlainTextSerializerBuilder beanMethodVisibility(Visibility value)
BeanContextBuilder
Only look for bean methods with the specified minimum visibility.
beanMethodVisibility
in class WriterSerializerBuilder
value
- The new value for this property.
Visibility.PUBLIC
public PlainTextSerializerBuilder beansRequireDefaultConstructor(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireDefaultConstructor
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class WriterSerializerBuilder
public PlainTextSerializerBuilder 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 WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class WriterSerializerBuilder
public PlainTextSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class WriterSerializerBuilder
public PlainTextSerializerBuilder beansRequireSomeProperties(boolean value)
BeanContextBuilder
If
Otherwise, the bean will be serialized as a string using the Object.toString()
method.
beansRequireSomeProperties
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder 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 WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder bpi(Class<?> beanClass, String value)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class WriterSerializerBuilder
beanClass
- The bean class.value
- Comma-delimited list of property names.public PlainTextSerializerBuilder bpi(Map<String,String> values)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class WriterSerializerBuilder
values
- The new value for this property.public PlainTextSerializerBuilder bpi(String beanClassName, String value)
BeanContextBuilder
Specifies the set and order of names of properties associated with the bean class.
bpi
in class WriterSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public PlainTextSerializerBuilder bpx(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean class.
bpx
in class WriterSerializerBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public PlainTextSerializerBuilder bpx(Map<String,String> values)
BeanContextBuilder
Specifies to exclude the specified list of properties for the specified bean classes.
bpx
in class WriterSerializerBuilder
values
- The new value for this property.public PlainTextSerializerBuilder bpx(String beanClassName, String value)
BeanContextBuilder
bpx
in class WriterSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public PlainTextSerializerBuilder bpro(Class<?> beanClass, String value)
BeanContextBuilder
Specifies the read-only properties for the specified bean class.
bpro
in class WriterSerializerBuilder
beanClass
- The bean class.value
- Comma-delimited list of property names.public PlainTextSerializerBuilder bpro(Map<String,String> values)
BeanContextBuilder
Specifies the read-only properties for the specified bean classes.
bpro
in class WriterSerializerBuilder
values
- The new value for this property.public PlainTextSerializerBuilder bpro(String beanClassName, String value)
BeanContextBuilder
Specifies the read-only properties for the specified bean class.
bpro
in class WriterSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public PlainTextSerializerBuilder bpwo(Class<?> beanClass, String properties)
BeanContextBuilder
Specifies the write-only properties for the specified bean class.
bpwo
in class WriterSerializerBuilder
beanClass
- The bean class.properties
- Comma-delimited list of property names.public PlainTextSerializerBuilder bpwo(Map<String,String> values)
BeanContextBuilder
Specifies the write-only properties for the specified bean classes.
bpwo
in class WriterSerializerBuilder
values
- The new value for this property.public PlainTextSerializerBuilder bpwo(String beanClassName, String value)
BeanContextBuilder
Specifies the write-only properties for the specified bean class.
bpwo
in class WriterSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public PlainTextSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class WriterSerializerBuilder
public PlainTextSerializerBuilder dictionary(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but takes in an array of classes.
dictionary
in class WriterSerializerBuilder
values
- The values to add to this property.public PlainTextSerializerBuilder dictionary(Object... values)
BeanContextBuilder
Adds to the list of classes that make up the bean dictionary in this bean context.
dictionary
in class WriterSerializerBuilder
values
- The values to add to this property.public PlainTextSerializerBuilder dictionaryReplace(Class<?>... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
dictionaryReplace
in class WriterSerializerBuilder
values
- The new values for this property.public PlainTextSerializerBuilder dictionaryReplace(Object... values)
BeanContextBuilder
Same as BeanContextBuilder.beanDictionary(Object...)
but replaces the existing value.
dictionaryReplace
in class WriterSerializerBuilder
values
- The new values for this property.public PlainTextSerializerBuilder dictionaryRemove(Class<?>... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.public PlainTextSerializerBuilder dictionaryRemove(Object... values)
BeanContextBuilder
Removes from the list of classes that make up the bean dictionary in this bean context.
dictionaryRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.public <T> PlainTextSerializerBuilder example(Class<T> c, T o)
BeanContextBuilder
Specifies an example of the specified class.
example
in class WriterSerializerBuilder
c
- The POJO class.o
- An instance of the POJO class used for examples.public <T> PlainTextSerializerBuilder exampleJson(Class<T> c, String value)
BeanContextBuilder
Specifies an example of the specified class.
exampleJson
in class WriterSerializerBuilder
T
- The POJO class type.c
- The POJO class.value
- The simple JSON representation of the example.public PlainTextSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class WriterSerializerBuilder
public PlainTextSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class WriterSerializerBuilder
public PlainTextSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class WriterSerializerBuilder
public PlainTextSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilder
implClass
in class WriterSerializerBuilder
interfaceClass
- The interface class.implClass
- The implementation class.public PlainTextSerializerBuilder 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 WriterSerializerBuilder
values
- The new value for this property.public PlainTextSerializerBuilder locale(Locale value)
BeanContextBuilder
Specifies a default locale for serializer and parser sessions.
locale
in class WriterSerializerBuilder
value
- The new value for this property.public PlainTextSerializerBuilder mediaType(MediaType value)
BeanContextBuilder
Specifies a default media type value for serializer and parser sessions.
mediaType
in class WriterSerializerBuilder
value
- The new value for this property.public PlainTextSerializerBuilder 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 WriterSerializerBuilder
values
- The values to add to this property.public PlainTextSerializerBuilder 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 WriterSerializerBuilder
values
- The values to add to this property.
public PlainTextSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class WriterSerializerBuilder
values
- The new value for this property.public PlainTextSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class WriterSerializerBuilder
values
- The new value for this property.
public PlainTextSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuilder
notBeanClassesRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.public PlainTextSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.
public PlainTextSerializerBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class WriterSerializerBuilder
values
- The values to add to this property.
public PlainTextSerializerBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class WriterSerializerBuilder
values
- The values to add to this property.public PlainTextSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuilder
notBeanPackagesReplace
in class WriterSerializerBuilder
values
- public PlainTextSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuilder
notBeanPackagesReplace
in class WriterSerializerBuilder
values
- public PlainTextSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuilder
notBeanPackagesRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.public PlainTextSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class WriterSerializerBuilder
values
- public PlainTextSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class WriterSerializerBuilder
values
- The values to add to this property.public PlainTextSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class WriterSerializerBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public PlainTextSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilder
pojoSwapsReplace
in class WriterSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public PlainTextSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilder
pojoSwapsReplace
in class WriterSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public PlainTextSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilder
pojoSwapsRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public PlainTextSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public PlainTextSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class WriterSerializerBuilder
public PlainTextSerializerBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class WriterSerializerBuilder
value
- The new value for this property.public PlainTextSerializerBuilder useEnumNames(boolean value)
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class WriterSerializerBuilder
value
- The property value.public PlainTextSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class WriterSerializerBuilder
public PlainTextSerializerBuilder useInterfaceProxies(boolean value)
BeanContextBuilder
If InvocationHandler
if there is no other way of instantiating them.
useInterfaceProxies
in class WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder 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 WriterSerializerBuilder
value
- The new value for this property.
public PlainTextSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class WriterSerializerBuilder
public PlainTextSerializerBuilder set(String name, Object value)
ContextBuilder
set
in class WriterSerializerBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public PlainTextSerializerBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class WriterSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public PlainTextSerializerBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class WriterSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public PlainTextSerializerBuilder addTo(String name, Object value)
ContextBuilder
addTo
in class WriterSerializerBuilder
name
- The property name.value
- The new value to add to the SET property.public PlainTextSerializerBuilder addTo(String name, String key, Object value)
ContextBuilder
addTo
in class WriterSerializerBuilder
name
- The property name.key
- The property value map key.value
- The property value map value.public PlainTextSerializerBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class WriterSerializerBuilder
name
- The property name.value
- The property value in the SET property.public PlainTextSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class WriterSerializerBuilder
copyFrom
- The factory whose settings are being copied.public PlainTextSerializerBuilder applyAnnotations(AnnotationList al, VarResolverSession vrs)
ContextBuilder
applyAnnotations
in class WriterSerializerBuilder
al
- The list of all annotations annotated with PropertyStoreApply
.vrs
- The string resolver for resolving variables in annotation values.public PlainTextSerializerBuilder applyAnnotations(Class<?>... fromClasses)
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 WriterSerializerBuilder
fromClasses
- The classes on which the annotations are defined.public PlainTextSerializerBuilder applyAnnotations(Method... fromMethods)
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 WriterSerializerBuilder
fromMethods
- The methods on which the annotations are defined.Copyright © 2016–2020 The Apache Software Foundation. All rights reserved.