public class XmlSerializerBuilder extends WriterSerializerBuilder
psb
Constructor and Description |
---|
XmlSerializerBuilder()
Constructor, default settings.
|
XmlSerializerBuilder(PropertyStore ps)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
XmlSerializerBuilder |
add(Map<String,Object> properties)
Adds multiple configuration properties on this object.
|
XmlSerializerBuilder |
addBeanTypes()
Configuration property: Add
|
XmlSerializerBuilder |
addBeanTypes(boolean value)
Configuration property: Add
|
XmlSerializerBuilder |
addNamespaceUrisToRoot()
Configuration property: Add namespace URLs to the root element.
|
XmlSerializerBuilder |
addNamespaceUrisToRoot(boolean value)
Configuration property: Add namespace URLs to the root element.
|
XmlSerializerBuilder |
addRootType()
Configuration property: Add type attribute to root nodes.
|
XmlSerializerBuilder |
addRootType(boolean value)
Configuration property: Add type attribute to root nodes.
|
XmlSerializerBuilder |
addTo(String name,
Object value)
Adds a value to a SET or LIST property.
|
XmlSerializerBuilder |
addTo(String name,
String key,
Object value)
Adds or overwrites a value to a SET, LIST, or MAP property.
|
XmlSerializerBuilder |
annotations(Annotation... values)
Configuration property: Annotations.
|
XmlSerializerBuilder |
apply(PropertyStore copyFrom)
Copies the settings from the specified property store into this builder.
|
XmlSerializerBuilder |
applyAnnotations(AnnotationList al,
VarResolverSession vrs)
Applies a set of annotations to this property store.
|
XmlSerializerBuilder |
applyAnnotations(Class<?>... fromClasses)
Applies any of the various
|
XmlSerializerBuilder |
applyAnnotations(Method... fromMethods)
Applies any of the various
|
XmlSerializerBuilder |
autoDetectNamespaces(boolean value)
Configuration property: Auto-detect namespace usage.
|
XmlSerializerBuilder |
beanClassVisibility(Visibility value)
Configuration property: Minimum bean class visibility.
|
XmlSerializerBuilder |
beanConstructorVisibility(Visibility value)
Configuration property: Minimum bean constructor visibility.
|
XmlSerializerBuilder |
beanDictionary(Class<?>... values)
Deprecated.
|
XmlSerializerBuilder |
beanDictionary(Object... values)
Deprecated.
|
XmlSerializerBuilder |
beanDictionaryRemove(Class<?>... values)
Deprecated.
|
XmlSerializerBuilder |
beanDictionaryRemove(Object... values)
Deprecated.
|
XmlSerializerBuilder |
beanDictionaryReplace(Class<?>... values)
Deprecated.
|
XmlSerializerBuilder |
beanDictionaryReplace(Object... values)
Deprecated.
|
XmlSerializerBuilder |
beanFieldVisibility(Visibility value)
Configuration property: Minimum bean field visibility.
|
XmlSerializerBuilder |
beanFilters(Class<?>... values)
Configuration property: Bean filters.
|
XmlSerializerBuilder |
beanFilters(Object... values)
Configuration property: Bean filters.
|
XmlSerializerBuilder |
beanFiltersRemove(Class<?>... values)
Configuration property: Bean filters.
|
XmlSerializerBuilder |
beanFiltersRemove(Object... values)
Configuration property: Bean filters.
|
XmlSerializerBuilder |
beanFiltersReplace(Class<?>... values)
Configuration property: Bean filters.
|
XmlSerializerBuilder |
beanFiltersReplace(Object... values)
Configuration property: Bean filters.
|
XmlSerializerBuilder |
beanMapPutReturnsOldValue()
Configuration property: BeanMap.put() returns old property value.
|
XmlSerializerBuilder |
beanMapPutReturnsOldValue(boolean value)
Configuration property: BeanMap.put() returns old property value.
|
XmlSerializerBuilder |
beanMethodVisibility(Visibility value)
Configuration property: Minimum bean method visibility.
|
XmlSerializerBuilder |
beansRequireDefaultConstructor()
Configuration property: Beans require no-arg constructors.
|
XmlSerializerBuilder |
beansRequireDefaultConstructor(boolean value)
Configuration property: Beans require no-arg constructors.
|
XmlSerializerBuilder |
beansRequireSerializable()
Configuration property: Beans require Serializable interface.
|
XmlSerializerBuilder |
beansRequireSerializable(boolean value)
Configuration property: Beans require Serializable interface.
|
XmlSerializerBuilder |
beansRequireSettersForGetters()
Configuration property: Beans require setters for getters.
|
XmlSerializerBuilder |
beansRequireSettersForGetters(boolean value)
Configuration property: Beans require setters for getters.
|
XmlSerializerBuilder |
beansRequireSomeProperties(boolean value)
Configuration property: Beans require at least one property.
|
XmlSerializerBuilder |
beanTypePropertyName(String value)
Configuration property: Bean type property name.
|
XmlSerializerBuilder |
bpi(Class<?> beanClass,
String value)
Configuration property: Bean property includes.
|
XmlSerializerBuilder |
bpi(Map<String,String> values)
Configuration property: Bean property includes.
|
XmlSerializerBuilder |
bpi(String beanClassName,
String value)
Configuration property: Bean property includes.
|
XmlSerializerBuilder |
bpro(Class<?> beanClass,
String value)
Configuration property: Read-only bean properties.
|
XmlSerializerBuilder |
bpro(Map<String,String> values)
Configuration property: Read-only bean properties.
|
XmlSerializerBuilder |
bpro(String beanClassName,
String value)
Configuration property: Read-only bean properties.
|
XmlSerializerBuilder |
bpwo(Class<?> beanClass,
String properties)
Configuration property: Write-only bean properties.
|
XmlSerializerBuilder |
bpwo(Map<String,String> values)
Configuration property: Write-only bean properties.
|
XmlSerializerBuilder |
bpwo(String beanClassName,
String value)
Configuration property: Write-only bean properties.
|
XmlSerializerBuilder |
bpx(Class<?> beanClass,
String properties)
Configuration property: Bean property excludes.
|
XmlSerializerBuilder |
bpx(Map<String,String> values)
Configuration property: Bean property excludes.
|
XmlSerializerBuilder |
bpx(String beanClassName,
String value)
Configuration property: Bean property excludes.
|
XmlSerializer |
build()
Build the object.
|
XmlSerializerBuilder |
debug()
Configuration property: Debug mode.
|
XmlSerializerBuilder |
defaultNamespace(String value)
Configuration property: Default namespace.
|
XmlSerializerBuilder |
detectRecursions()
Configuration property: Automatically detect POJO recursions.
|
XmlSerializerBuilder |
detectRecursions(boolean value)
Configuration property: Automatically detect POJO recursions.
|
XmlSerializerBuilder |
dictionary(Class<?>... values)
Configuration property: Bean dictionary.
|
XmlSerializerBuilder |
dictionary(Object... values)
Configuration property: Bean dictionary.
|
XmlSerializerBuilder |
dictionaryRemove(Class<?>... values)
Configuration property: Bean dictionary.
|
XmlSerializerBuilder |
dictionaryRemove(Object... values)
Configuration property: Bean dictionary.
|
XmlSerializerBuilder |
dictionaryReplace(Class<?>... values)
Configuration property: Bean dictionary.
|
XmlSerializerBuilder |
dictionaryReplace(Object... values)
Configuration property: Bean dictionary.
|
XmlSerializerBuilder |
enableNamespaces()
Configuration property: Enable support for XML namespaces.
|
XmlSerializerBuilder |
enableNamespaces(boolean value)
Configuration property: Enable support for XML namespaces.
|
<T> XmlSerializerBuilder |
example(Class<T> c,
T o)
Configuration property: POJO example.
|
<T> XmlSerializerBuilder |
exampleJson(Class<T> c,
String value)
Configuration property: POJO example.
|
XmlSerializerBuilder |
fileCharset(Charset value)
Configuration property: File charset.
|
XmlSerializerBuilder |
ignoreInvocationExceptionsOnGetters()
Configuration property: Ignore invocation errors on getters.
|
XmlSerializerBuilder |
ignoreInvocationExceptionsOnGetters(boolean value)
Configuration property: Ignore invocation errors on getters.
|
XmlSerializerBuilder |
ignoreInvocationExceptionsOnSetters()
Configuration property: Ignore invocation errors on setters.
|
XmlSerializerBuilder |
ignoreInvocationExceptionsOnSetters(boolean value)
Configuration property: Ignore invocation errors on setters.
|
XmlSerializerBuilder |
ignorePropertiesWithoutSetters(boolean value)
Configuration property: Ignore properties without setters.
|
XmlSerializerBuilder |
ignoreRecursions()
Configuration property: Ignore recursion errors.
|
XmlSerializerBuilder |
ignoreRecursions(boolean value)
Configuration property: Ignore recursion errors.
|
XmlSerializerBuilder |
ignoreUnknownBeanProperties()
Configuration property: Ignore unknown properties.
|
XmlSerializerBuilder |
ignoreUnknownBeanProperties(boolean value)
Configuration property: Ignore unknown properties.
|
XmlSerializerBuilder |
ignoreUnknownNullBeanProperties(boolean value)
Configuration property: Ignore unknown properties with null values.
|
XmlSerializerBuilder |
implClass(Class<?> interfaceClass,
Class<?> implClass)
Configuration property: Implementation classes.
|
XmlSerializerBuilder |
implClasses(Map<String,Class<?>> values)
Configuration property: Implementation classes.
|
XmlSerializerBuilder |
initialDepth(int value)
Configuration property: Initial depth.
|
XmlSerializerBuilder |
listener(Class<? extends SerializerListener> value)
Configuration property: Serializer listener.
|
XmlSerializerBuilder |
locale(Locale value)
Configuration property: Locale.
|
XmlSerializerBuilder |
maxDepth(int value)
Configuration property: Max traversal depth.
|
XmlSerializerBuilder |
maxIndent(int value)
Configuration property: Maximum indentation.
|
XmlSerializerBuilder |
mediaType(MediaType value)
Configuration property: Media type.
|
XmlSerializerBuilder |
namespaces(Namespace... values)
Configuration property: Default namespaces.
|
XmlSerializerBuilder |
namespaces(String... values)
Configuration property: Default namespaces.
|
XmlSerializerBuilder |
notBeanClasses(Class<?>... values)
Configuration property: Bean class exclusions.
|
XmlSerializerBuilder |
notBeanClasses(Object... values)
Configuration property: Bean class exclusions.
|
XmlSerializerBuilder |
notBeanClassesRemove(Class<?>... values)
Configuration property: Bean class exclusions.
|
XmlSerializerBuilder |
notBeanClassesRemove(Object... values)
Configuration property: Bean class exclusions.
|
XmlSerializerBuilder |
notBeanClassesReplace(Class<?>... values)
Configuration property: Bean class exclusions.
|
XmlSerializerBuilder |
notBeanClassesReplace(Object... values)
Configuration property: Bean class exclusions.
|
XmlSerializerBuilder |
notBeanPackages(Object... values)
Configuration property: Bean package exclusions.
|
XmlSerializerBuilder |
notBeanPackages(String... values)
Configuration property: Bean package exclusions.
|
XmlSerializerBuilder |
notBeanPackagesRemove(Object... values)
Configuration property: Bean package exclusions.
|
XmlSerializerBuilder |
notBeanPackagesRemove(String... values)
Configuration property: Bean package exclusions.
|
XmlSerializerBuilder |
notBeanPackagesReplace(Object... values)
Configuration property: Bean package exclusions.
|
XmlSerializerBuilder |
notBeanPackagesReplace(String... values)
Configuration property: Bean package exclusions.
|
XmlSerializerBuilder |
ns()
Configuration property: Enable support for XML namespaces.
|
XmlSerializerBuilder |
pojoSwaps(Class<?>... values)
Configuration property: POJO swaps.
|
XmlSerializerBuilder |
pojoSwaps(Object... values)
Configuration property: POJO swaps.
|
XmlSerializerBuilder |
pojoSwapsRemove(Class<?>... values)
Configuration property: POJO swaps.
|
XmlSerializerBuilder |
pojoSwapsRemove(Object... values)
Configuration property: POJO swaps.
|
XmlSerializerBuilder |
pojoSwapsReplace(Class<?>... values)
Configuration property: POJO swaps.
|
XmlSerializerBuilder |
pojoSwapsReplace(Object... values)
Configuration property: POJO swaps.
|
XmlSerializerBuilder |
quoteChar(char value)
Configuration property: Quote character.
|
XmlSerializerBuilder |
removeFrom(String name,
Object value)
Removes a value from a SET, LIST, or MAP property.
|
XmlSerializerBuilder |
set(Map<String,Object> properties)
Sets multiple configuration properties on this object.
|
XmlSerializerBuilder |
set(String name,
Object value)
Sets a configuration property on this object.
|
XmlSerializerBuilder |
sortCollections()
Configuration property: Sort arrays and collections alphabetically.
|
XmlSerializerBuilder |
sortCollections(boolean value)
Configuration property: Sort arrays and collections alphabetically.
|
XmlSerializerBuilder |
sortMaps()
Configuration property: Sort maps alphabetically.
|
XmlSerializerBuilder |
sortMaps(boolean value)
Configuration property: Sort maps alphabetically.
|
XmlSerializerBuilder |
sortProperties()
Configuration property: Sort bean properties.
|
XmlSerializerBuilder |
sortProperties(boolean value)
Configuration property: Sort bean properties.
|
XmlSerializerBuilder |
sq()
Configuration property: Quote character.
|
XmlSerializerBuilder |
streamCharset(Charset value)
Configuration property: Output stream charset.
|
XmlSerializerBuilder |
timeZone(TimeZone value)
Configuration property: TimeZone.
|
XmlSerializerBuilder |
trimEmptyCollections()
Configuration property: Trim empty lists and arrays.
|
XmlSerializerBuilder |
trimEmptyCollections(boolean value)
Configuration property: Trim empty lists and arrays.
|
XmlSerializerBuilder |
trimEmptyMaps()
Configuration property: Trim empty maps.
|
XmlSerializerBuilder |
trimEmptyMaps(boolean value)
Configuration property: Trim empty maps.
|
XmlSerializerBuilder |
trimNullProperties(boolean value)
Configuration property: Trim null bean property values.
|
XmlSerializerBuilder |
trimStrings()
Configuration property: Trim strings.
|
XmlSerializerBuilder |
trimStrings(boolean value)
Configuration property: Trim strings.
|
XmlSerializerBuilder |
uriContext(UriContext value)
Configuration property: URI context bean.
|
XmlSerializerBuilder |
uriRelativity(UriRelativity value)
Configuration property: URI relativity.
|
XmlSerializerBuilder |
uriResolution(UriResolution value)
Configuration property: URI resolution.
|
XmlSerializerBuilder |
useEnumNames()
Configuration property: Use enum names.
|
XmlSerializerBuilder |
useEnumNames(boolean value)
Configuration property: Use enum names.
|
XmlSerializerBuilder |
useInterfaceProxies(boolean value)
Configuration property: Use interface proxies.
|
XmlSerializerBuilder |
useJavaBeanIntrospector()
Configuration property: Use Java Introspector.
|
XmlSerializerBuilder |
useJavaBeanIntrospector(boolean value)
Configuration property: Use Java Introspector.
|
XmlSerializerBuilder |
useWhitespace()
Configuration property: Use whitespace.
|
XmlSerializerBuilder |
useWhitespace(boolean value)
Configuration property: Use whitespace.
|
XmlSerializerBuilder |
ws()
Configuration property: Use whitespace.
|
XmlSerializerBuilder |
xsNamespace(Namespace value)
Configuration property: XMLSchema namespace.
|
XmlSerializerBuilder |
xsNamespace(String value)
Configuration property: XMLSchema namespace.
|
uriContext, uriRelativity, uriResolution
debug, examples, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer
build, getPropertyStore, getPropertyStoreBuilder, peek, peek
public XmlSerializerBuilder()
public XmlSerializerBuilder(PropertyStore ps)
ps
- The initial configuration settings for this builder.public XmlSerializer build()
ContextBuilder
build
in class WriterSerializerBuilder
public XmlSerializerBuilder addNamespaceUrisToRoot(boolean value)
Use this setting to add xmlns:x
attributes to the root element for the default and all mapped namespaces.
value
- The new value for this property.
public XmlSerializerBuilder addNamespaceUrisToRoot()
Shortcut for calling addNamespaceUrisToRoot(
.
public XmlSerializerBuilder autoDetectNamespaces(boolean value)
Detect namespace usage before serialization.
value
- The new value for this property.
public XmlSerializerBuilder defaultNamespace(String value)
Specifies the default namespace URI for this document.
value
- The new value for this property.
public XmlSerializerBuilder enableNamespaces(boolean value)
If not enabled, XML output will not contain any namespaces regardless of any other settings.
value
- The new value for this property.
public XmlSerializerBuilder enableNamespaces()
Shortcut for calling enableNamespaces(
.
public XmlSerializerBuilder ns()
Shortcut for calling enableNamespaces(
.
public XmlSerializerBuilder namespaces(Namespace... values)
The default list of namespaces associated with this serializer.
values
- The new value for this property.public XmlSerializerBuilder namespaces(String... values)
The default list of namespaces associated with this serializer.
values
- The new value for this property.public XmlSerializerBuilder xsNamespace(Namespace value)
Specifies the namespace for the XmlSchemaSerializer
class.
value
- The new value for this property.
public XmlSerializerBuilder xsNamespace(String value)
Specifies the namespace for the XmlSchemaSerializer
class.
value
- The new value for this property.
public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder sq()
WriterSerializerBuilder
Shortcut for calling quoteChar(
.
sq
in class WriterSerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder useWhitespace(boolean value)
WriterSerializerBuilder
If
useWhitespace
in class WriterSerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder useWhitespace()
WriterSerializerBuilder
Shortcut for calling useWhitespace(
.
useWhitespace
in class WriterSerializerBuilder
public XmlSerializerBuilder ws()
WriterSerializerBuilder
Shortcut for calling useWhitespace(
.
ws
in class WriterSerializerBuilder
public XmlSerializerBuilder addBeanTypes(boolean value)
SerializerBuilder
If
addBeanTypes
in class SerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder addBeanTypes()
SerializerBuilder
Shortcut for calling addBeanTypes(
.
addBeanTypes
in class SerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder addRootType()
SerializerBuilder
Shortcut for calling addRootType(
.
addRootType
in class SerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder detectRecursions()
BeanTraverseBuilder
Shortcut for calling detectRecursions(
.
detectRecursions
in class SerializerBuilder
public XmlSerializerBuilder ignoreRecursions(boolean value)
BeanTraverseBuilder
If
ignoreRecursions
in class SerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder ignoreRecursions()
BeanTraverseBuilder
Shortcut for calling ignoreRecursions(
.
ignoreRecursions
in class SerializerBuilder
public XmlSerializerBuilder initialDepth(int value)
BeanTraverseBuilder
The initial indentation level at the root.
initialDepth
in class SerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder sortCollections()
SerializerBuilder
Shortcut for calling sortCollections(
.
sortCollections
in class SerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder sortMaps()
SerializerBuilder
Shortcut for calling sortMaps(
.
sortMaps
in class SerializerBuilder
public XmlSerializerBuilder trimEmptyCollections(boolean value)
SerializerBuilder
If
trimEmptyCollections
in class SerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder trimEmptyCollections()
SerializerBuilder
Shortcut for calling trimEmptyCollections(
.
trimEmptyCollections
in class SerializerBuilder
public XmlSerializerBuilder trimEmptyMaps(boolean value)
SerializerBuilder
If
trimEmptyMaps
in class SerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder trimEmptyMaps()
SerializerBuilder
Shortcut for calling trimEmptyMaps(
.
trimEmptyMaps
in class SerializerBuilder
public XmlSerializerBuilder trimNullProperties(boolean value)
SerializerBuilder
If
trimNullProperties
in class SerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder trimStrings(boolean value)
SerializerBuilder
If String.trim()
before being serialized.
trimStrings
in class SerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder trimStrings()
SerializerBuilder
Shortcut for calling trimStrings(
.
trimStrings
in class SerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder beanMapPutReturnsOldValue()
BeanContextBuilder
Shortcut for calling beanMapPutReturnsOldValue(
.
beanMapPutReturnsOldValue
in class WriterSerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder beansRequireDefaultConstructor()
BeanContextBuilder
Shortcut for calling beansRequireDefaultConstructor(
.
beansRequireDefaultConstructor
in class WriterSerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder beansRequireSerializable()
BeanContextBuilder
Shortcut for calling beansRequireSerializable(
.
beansRequireSerializable
in class WriterSerializerBuilder
public XmlSerializerBuilder beansRequireSettersForGetters(boolean value)
BeanContextBuilder
If
Otherwise, they will be ignored.
beansRequireSettersForGetters
in class WriterSerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder beansRequireSettersForGetters()
BeanContextBuilder
Shortcut for calling beansRequireSettersForGetters(
.
beansRequireSettersForGetters
in class WriterSerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder bpx(String beanClassName, String value)
BeanContextBuilder
bpx
in class WriterSerializerBuilder
beanClassName
- The bean class name.
value
- Comma-delimited list of property names.public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder debug()
BeanContextBuilder
Shortcut for calling debug(
.
debug
in class WriterSerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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> XmlSerializerBuilder 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> XmlSerializerBuilder 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 XmlSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
BeanContextBuilder
If BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnGetters
in class WriterSerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder ignoreInvocationExceptionsOnGetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnGetters(
.
ignoreInvocationExceptionsOnGetters
in class WriterSerializerBuilder
public XmlSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreInvocationExceptionsOnSetters
in class WriterSerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder ignoreInvocationExceptionsOnSetters()
BeanContextBuilder
Shortcut for calling ignoreInvocationExceptionsOnSetters(
.
ignoreInvocationExceptionsOnSetters
in class WriterSerializerBuilder
public XmlSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignorePropertiesWithoutSetters
in class WriterSerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder ignoreUnknownBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownBeanProperties
in class WriterSerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder ignoreUnknownBeanProperties()
BeanContextBuilder
Shortcut for calling ignoreUnknownBeanProperties(
.
ignoreUnknownBeanProperties
in class WriterSerializerBuilder
public XmlSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
BeanContextBuilder
If
Otherwise, a BeanRuntimeException
is thrown.
ignoreUnknownNullBeanProperties
in class WriterSerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder implClass(Class<?> interfaceClass, Class<?> implClass)
BeanContextBuilder
implClass
in class WriterSerializerBuilder
interfaceClass
- The interface class.implClass
- The implementation class.public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder notBeanClassesReplace(Class<?>... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class WriterSerializerBuilder
values
- The new value for this property.public XmlSerializerBuilder notBeanClassesReplace(Object... values)
BeanContextBuilder
Not-bean classes are converted to
notBeanClassesReplace
in class WriterSerializerBuilder
values
- The new value for this property.
public XmlSerializerBuilder notBeanClassesRemove(Class<?>... values)
BeanContextBuilder
notBeanClassesRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.public XmlSerializerBuilder notBeanClassesRemove(Object... values)
BeanContextBuilder
notBeanClassesRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.
public XmlSerializerBuilder notBeanPackages(Object... values)
BeanContextBuilder
notBeanPackages
in class WriterSerializerBuilder
values
- The values to add to this property.
public XmlSerializerBuilder notBeanPackages(String... values)
BeanContextBuilder
notBeanPackages
in class WriterSerializerBuilder
values
- The values to add to this property.public XmlSerializerBuilder notBeanPackagesReplace(String... values)
BeanContextBuilder
notBeanPackagesReplace
in class WriterSerializerBuilder
values
- public XmlSerializerBuilder notBeanPackagesReplace(Object... values)
BeanContextBuilder
notBeanPackagesReplace
in class WriterSerializerBuilder
values
- public XmlSerializerBuilder notBeanPackagesRemove(String... values)
BeanContextBuilder
notBeanPackagesRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.public XmlSerializerBuilder notBeanPackagesRemove(Object... values)
BeanContextBuilder
notBeanPackagesRemove
in class WriterSerializerBuilder
values
- public XmlSerializerBuilder pojoSwaps(Class<?>... values)
BeanContextBuilder
pojoSwaps
in class WriterSerializerBuilder
values
- The values to add to this property.public XmlSerializerBuilder pojoSwaps(Object... values)
BeanContextBuilder
pojoSwaps
in class WriterSerializerBuilder
values
- The values to add to this property.
PojoSwap
.
SurrogateSwap
.
public XmlSerializerBuilder pojoSwapsReplace(Class<?>... values)
BeanContextBuilder
pojoSwapsReplace
in class WriterSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public XmlSerializerBuilder pojoSwapsReplace(Object... values)
BeanContextBuilder
pojoSwapsReplace
in class WriterSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public XmlSerializerBuilder pojoSwapsRemove(Class<?>... values)
BeanContextBuilder
pojoSwapsRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public XmlSerializerBuilder pojoSwapsRemove(Object... values)
BeanContextBuilder
pojoSwapsRemove
in class WriterSerializerBuilder
values
- The values to remove from this property.
PojoSwap
.
SurrogateSwap
.
public XmlSerializerBuilder sortProperties(boolean value)
BeanContextBuilder
When
sortProperties
in class WriterSerializerBuilder
value
- The new value for this property.
public XmlSerializerBuilder sortProperties()
BeanContextBuilder
Shortcut for calling sortProperties(
.
sortProperties
in class WriterSerializerBuilder
public XmlSerializerBuilder timeZone(TimeZone value)
BeanContextBuilder
timeZone
in class WriterSerializerBuilder
value
- The new value for this property.public XmlSerializerBuilder 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 XmlSerializerBuilder useEnumNames()
BeanContextBuilder
When enabled, enums are always serialized by name instead of using Object.toString()
.
useEnumNames
in class WriterSerializerBuilder
public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder useJavaBeanIntrospector()
BeanContextBuilder
Shortcut for calling useJavaBeanIntrospector(
.
useJavaBeanIntrospector
in class WriterSerializerBuilder
public XmlSerializerBuilder set(String name, Object value)
ContextBuilder
set
in class WriterSerializerBuilder
name
- The property name.value
- The property value.PropertyStoreBuilder.set(String, Object)
public XmlSerializerBuilder set(Map<String,Object> properties)
ContextBuilder
set
in class WriterSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.set(java.util.Map)
public XmlSerializerBuilder add(Map<String,Object> properties)
ContextBuilder
add
in class WriterSerializerBuilder
properties
- The properties to set on this class.PropertyStoreBuilder.add(java.util.Map)
public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder removeFrom(String name, Object value)
ContextBuilder
removeFrom
in class WriterSerializerBuilder
name
- The property name.value
- The property value in the SET property.public XmlSerializerBuilder apply(PropertyStore copyFrom)
ContextBuilder
apply
in class WriterSerializerBuilder
copyFrom
- The factory whose settings are being copied.public XmlSerializerBuilder 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 XmlSerializerBuilder 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 XmlSerializerBuilder 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.