XmlSerializerBuilder (Apache Juneau 7.2.1)

java.lang.Object
- org.apache.juneau.ContextBuilder
- - org.apache.juneau.BeanContextBuilder
  - - org.apache.juneau.BeanTraverseBuilder
    - - org.apache.juneau.serializer.SerializerBuilder
      - org.apache.juneau.serializer.WriterSerializerBuilder
        
        org.apache.juneau.xml.XmlSerializerBuilder

Direct Known Subclasses:

HtmlSerializerBuilder, SoapXmlSerializerBuilder, XmlSchemaSerializerBuilder, XmlSchemaSerializerBuilder
```
public class XmlSerializerBuilder
extends WriterSerializerBuilder
```
Builder class for building instances of XML serializers.

Field Summary
- Fields inherited from class org.apache.juneau.ContextBuilder
  psb

Constructor Summary

Constructors
Constructor and Description

XmlSerializerBuilder()
Constructor, default settings.

XmlSerializerBuilder(PropertyStore ps)
Constructor.

Constructors
Constructor and Description
`XmlSerializerBuilder()` Constructor, default settings.
`XmlSerializerBuilder(PropertyStore ps)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`XmlSerializerBuilder`	`abridged()` Deprecated. Use `Serializer.SERIALIZER_addRootType`.
`XmlSerializerBuilder`	`abridged(boolean value)` Deprecated. Use `Serializer.SERIALIZER_addRootType`.
`XmlSerializerBuilder`	`add(Map<String,Object> properties)` Adds multiple configuration properties on this object.
`XmlSerializerBuilder`	`addBeanTypeProperties(boolean value)` Deprecated. `addBeanTypes(boolean)`
`XmlSerializerBuilder`	`addBeanTypes()` Configuration property: Add "_type" properties when needed.
`XmlSerializerBuilder`	`addBeanTypes(boolean value)` Configuration property: Add "_type" properties when needed.
`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`	`apply(PropertyStore copyFrom)` Copies the settings from the specified property store into this builder.
`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(boolean append, Object... values)` Configuration property: Bean dictionary.
`XmlSerializerBuilder`	`beanDictionary(Class<?>... values)` Configuration property: Bean dictionary.
`XmlSerializerBuilder`	`beanDictionary(Object... values)` Configuration property: Bean dictionary.
`XmlSerializerBuilder`	`beanDictionaryRemove(Object... values)` Configuration property: Bean dictionary.
`XmlSerializerBuilder`	`beanFieldVisibility(Visibility value)` Configuration property: Minimum bean field visibility.
`XmlSerializerBuilder`	`beanFilters(boolean append, Object... values)` Configuration property: Bean filters.
`XmlSerializerBuilder`	`beanFilters(Class<?>... values)` Configuration property: Bean filters.
`XmlSerializerBuilder`	`beanFilters(Object... values)` Configuration property: Bean filters.
`XmlSerializerBuilder`	`beanFiltersRemove(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.
`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`	`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.
`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.
`<T> XmlSerializerBuilder`	`implClass(Class<T> interfaceClass, Class<? extends T> 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`	`notBeanClasses(boolean append, Object... values)` Configuration property: Bean class exclusions.
`XmlSerializerBuilder`	`notBeanClasses(Class<?>... values)` Configuration property: Bean class exclusions.
`XmlSerializerBuilder`	`notBeanClasses(Object... values)` Configuration property: Bean class exclusions.
`XmlSerializerBuilder`	`notBeanClassesRemove(Object... values)` Configuration property: Bean class exclusions.
`XmlSerializerBuilder`	`notBeanPackages(boolean append, Object... values)` Configuration property: Bean package 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`	`ns()` Configuration property: Enable support for XML namespaces.
`XmlSerializerBuilder`	`pojoSwaps(boolean append, Object... values)` Configuration property: POJO swaps.
`XmlSerializerBuilder`	`pojoSwaps(Class<?>... values)` Configuration property: POJO swaps.
`XmlSerializerBuilder`	`pojoSwaps(Object... values)` Configuration property: POJO swaps.
`XmlSerializerBuilder`	`pojoSwapsRemove(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(boolean append, String name, Object value)` Sets or adds to a SET or LIST 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`	`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`	`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.

Methods inherited from class org.apache.juneau.serializer.SerializerBuilder
uriContext, uriRelativity, uriResolution

Methods inherited from class org.apache.juneau.BeanContextBuilder
debug, excludeProperties, excludeProperties, excludeProperties, fluentSetters, fluentSetters, includeProperties, includeProperties, includeProperties, propertyNamer

Methods inherited from class org.apache.juneau.ContextBuilder
build, getPropertyStore, getPropertyStoreBuilder

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - XmlSerializerBuilder
```
public XmlSerializerBuilder()
```
    Constructor, default settings.
  - XmlSerializerBuilder
```
public XmlSerializerBuilder(PropertyStore ps)
```
    Constructor.
    
    Parameters:
    
    ps - The initial configuration settings for this builder.
- Method Detail
  - build
```
public XmlSerializer build()
```
    Description copied from class: ContextBuilder
    
    Build the object.
    
    Overrides:
    
    build in class WriterSerializerBuilder
    
    Returns:
    
    The built object. Subsequent calls to this method will create new instances.
  - addNamespaceUrisToRoot
```
public XmlSerializerBuilder addNamespaceUrisToRoot(boolean value)
```
    Configuration property: Add namespace URLs to the root element.
    Use this setting to add xmlns:x attributes to the root element for the default and all mapped namespaces.
    See Also:
    - XmlSerializer.XML_addNamespaceUrisToRoot
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - addNamespaceUrisToRoot
```
public XmlSerializerBuilder addNamespaceUrisToRoot()
```
    Configuration property: Add namespace URLs to the root element.
    Shortcut for calling addNamespaceUrisToRoot(true).
    See Also:
    - XmlSerializer.XML_addNamespaceUrisToRoot
    Returns:
    
    This object (for method chaining).
  - autoDetectNamespaces
```
public XmlSerializerBuilder autoDetectNamespaces(boolean value)
```
    Configuration property: Auto-detect namespace usage.
    Detect namespace usage before serialization.
    See Also:
    - XmlSerializer.XML_autoDetectNamespaces
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - defaultNamespace
```
public XmlSerializerBuilder defaultNamespace(String value)
```
    Configuration property: Default namespace.
    Specifies the default namespace URI for this document.
    See Also:
    - XmlSerializer.XML_defaultNamespace
    Parameters:
    
    value - The new value for this property.
    The default is "juneau: http://www.apache.org/2013/Juneau".
    
    Returns:
    
    This object (for method chaining).
  - enableNamespaces
```
public XmlSerializerBuilder enableNamespaces(boolean value)
```
    Configuration property: Enable support for XML namespaces.
    If not enabled, XML output will not contain any namespaces regardless of any other settings.
    See Also:
    - XmlSerializer.XML_enableNamespaces
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - enableNamespaces
```
public XmlSerializerBuilder enableNamespaces()
```
    Configuration property: Enable support for XML namespaces.
    Shortcut for calling enableNamespaces(true).
    See Also:
    - XmlSerializer.XML_enableNamespaces
    Returns:
    
    This object (for method chaining).
  - ns
```
public XmlSerializerBuilder ns()
```
    Configuration property: Enable support for XML namespaces.
    Shortcut for calling enableNamespaces(true).
    See Also:
    - XmlSerializer.XML_enableNamespaces
    Returns:
    
    This object (for method chaining).
  - namespaces
```
public XmlSerializerBuilder namespaces(Namespace... values)
```
    Configuration property: Default namespaces.
    The default list of namespaces associated with this serializer.
    See Also:
    - XmlSerializer.XML_namespaces
    Parameters:
    
    values - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - xsNamespace
```
public XmlSerializerBuilder xsNamespace(Namespace value)
```
    Configuration property: XMLSchema namespace.
    Specifies the namespace for the XMLSchema namespace, used by the schema generated by the XmlSchemaSerializer class.
    See Also:
    - XmlSerializer.XML_xsNamespace
    Parameters:
    
    value - The new value for this property.
    The default is "xs: http://www.w3.org/2001/XMLSchema".
    
    Returns:
    
    This object (for method chaining).
  - maxIndent
```
public XmlSerializerBuilder maxIndent(int value)
```
    Description copied from class: WriterSerializerBuilder
    Configuration property: Maximum indentation.
    Specifies the maximum indentation level in the serialized document.
    See Also:
    - WriterSerializer.WSERIALIZER_maxIndent
    Overrides:
    
    maxIndent in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is 100.
    
    Returns:
    
    This object (for method chaining).
  - quoteChar
```
public XmlSerializerBuilder quoteChar(char value)
```
    Description copied from class: WriterSerializerBuilder
    Configuration property: Quote character.
    This is the character used for quoting attributes and values.
    See Also:
    - WriterSerializer.WSERIALIZER_quoteChar
    Overrides:
    
    quoteChar in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is '"'.
    
    Returns:
    
    This object (for method chaining).
  - sq
```
public XmlSerializerBuilder sq()
```
    Description copied from class: WriterSerializerBuilder
    Configuration property: Quote character.
    Shortcut for calling quoteChar('\'').
    See Also:
    - WriterSerializer.WSERIALIZER_quoteChar
    Overrides:
    
    sq in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - useWhitespace
```
public XmlSerializerBuilder useWhitespace(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Use whitespace.
    If true, newlines and indentation and spaces are added to the output to improve readability.
    See Also:
    - Serializer.SERIALIZER_useWhitespace
    Overrides:
    
    useWhitespace in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - useWhitespace
```
public XmlSerializerBuilder useWhitespace()
```
    Description copied from class: SerializerBuilder
    Configuration property: Use whitespace.
    Shortcut for calling useWhitespace(true).
    See Also:
    - Serializer.SERIALIZER_useWhitespace
    Overrides:
    
    useWhitespace in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - ws
```
public XmlSerializerBuilder ws()
```
    Description copied from class: SerializerBuilder
    Configuration property: Use whitespace.
    Shortcut for calling useWhitespace(true).
    See Also:
    - Serializer.SERIALIZER_useWhitespace
    Overrides:
    
    ws in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - addBeanTypes
```
public XmlSerializerBuilder addBeanTypes(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Add "_type" properties when needed.
    If true, then "_type" properties will be added to beans if their type cannot be inferred through reflection.
    See Also:
    - Serializer.SERIALIZER_addBeanTypes
    Overrides:
    
    addBeanTypes in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - addBeanTypes
```
public XmlSerializerBuilder addBeanTypes()
```
    Description copied from class: SerializerBuilder
    Configuration property: Add "_type" properties when needed.
    Shortcut for calling addBeanTypes(true).
    See Also:
    - Serializer.SERIALIZER_addBeanTypes
    Overrides:
    
    addBeanTypes in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - addRootType
```
public XmlSerializerBuilder addRootType(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Add type attribute to root nodes.
    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.
    See Also:
    - Serializer.SERIALIZER_addRootType
    Overrides:
    
    addRootType in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - addRootType
```
public XmlSerializerBuilder addRootType()
```
    Description copied from class: SerializerBuilder
    Configuration property: Add type attribute to root nodes.
    Shortcut for calling addRootType(true).
    See Also:
    - Serializer.SERIALIZER_addRootType
    Overrides:
    
    addRootType in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - detectRecursions
```
public XmlSerializerBuilder detectRecursions(boolean value)
```
    Description copied from class: BeanTraverseBuilder
    Configuration property: Automatically detect POJO recursions.
    Specifies that recursions should be checked for during traversal.
    Notes:
    - Checking for recursion can cause a small performance penalty.
    See Also:
    - BeanTraverseContext.BEANTRAVERSE_detectRecursions
    Overrides:
    
    detectRecursions in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - detectRecursions
```
public XmlSerializerBuilder detectRecursions()
```
    Description copied from class: BeanTraverseBuilder
    Configuration property: Automatically detect POJO recursions.
    Shortcut for calling detectRecursions(true).
    See Also:
    - BeanTraverseContext.BEANTRAVERSE_detectRecursions
    Overrides:
    
    detectRecursions in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - ignoreRecursions
```
public XmlSerializerBuilder ignoreRecursions(boolean value)
```
    Description copied from class: BeanTraverseBuilder
    Configuration property: Ignore recursion errors.
    If true, when we encounter the same object when traversing a tree, we set the value to null. Otherwise, an exception is thrown.
    Notes:
    - Checking for recursion can cause a small performance penalty.
    See Also:
    - BeanTraverseContext.BEANTRAVERSE_ignoreRecursions
    Overrides:
    
    ignoreRecursions in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreRecursions
```
public XmlSerializerBuilder ignoreRecursions()
```
    Description copied from class: BeanTraverseBuilder
    Configuration property: Ignore recursion errors.
    Shortcut for calling ignoreRecursions(true).
    See Also:
    - BeanTraverseContext.BEANTRAVERSE_ignoreRecursions
    Overrides:
    
    ignoreRecursions in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - initialDepth
```
public XmlSerializerBuilder initialDepth(int value)
```
    Description copied from class: BeanTraverseBuilder
    Configuration property: Initial depth.
    The initial indentation level at the root.
    See Also:
    - BeanTraverseContext.BEANTRAVERSE_initialDepth
    Overrides:
    
    initialDepth in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is 0.
    
    Returns:
    
    This object (for method chaining).
  - listener
```
public XmlSerializerBuilder listener(Class<? extends SerializerListener> value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Serializer listener.
    Class used to listen for errors and warnings that occur during serialization.
    See Also:
    - Serializer.SERIALIZER_listener
    Overrides:
    
    listener in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - maxDepth
```
public XmlSerializerBuilder maxDepth(int value)
```
    Description copied from class: BeanTraverseBuilder
    Configuration property: Max traversal depth.
    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.
    See Also:
    - BeanTraverseContext.BEANTRAVERSE_maxDepth
    Overrides:
    
    maxDepth in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is 100.
    
    Returns:
    
    This object (for method chaining).
  - sortCollections
```
public XmlSerializerBuilder sortCollections(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Sort arrays and collections alphabetically.
    Copies and sorts the contents of arrays and collections before serializing them.
    See Also:
    - Serializer.SERIALIZER_sortCollections
    Overrides:
    
    sortCollections in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - sortCollections
```
public XmlSerializerBuilder sortCollections()
```
    Description copied from class: SerializerBuilder
    Configuration property: Sort arrays and collections alphabetically.
    Shortcut for calling sortCollections(true).
    See Also:
    - Serializer.SERIALIZER_sortCollections
    Overrides:
    
    sortCollections in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - sortMaps
```
public XmlSerializerBuilder sortMaps(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Sort maps alphabetically.
    Copies and sorts the contents of maps before serializing them.
    See Also:
    - Serializer.SERIALIZER_sortMaps
    Overrides:
    
    sortMaps in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - sortMaps
```
public XmlSerializerBuilder sortMaps()
```
    Description copied from class: SerializerBuilder
    Configuration property: Sort maps alphabetically.
    Shortcut for calling sortMaps(true).
    See Also:
    - Serializer.SERIALIZER_sortMaps
    Overrides:
    
    sortMaps in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - trimEmptyCollections
```
public XmlSerializerBuilder trimEmptyCollections(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Trim empty lists and arrays.
    If true, empty list values will not be serialized to the output.
    See Also:
    - Serializer.SERIALIZER_trimEmptyCollections
    Overrides:
    
    trimEmptyCollections in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - trimEmptyCollections
```
public XmlSerializerBuilder trimEmptyCollections()
```
    Description copied from class: SerializerBuilder
    Configuration property: Trim empty lists and arrays.
    Shortcut for calling trimEmptyCollections(true).
    See Also:
    - Serializer.SERIALIZER_trimEmptyCollections
    Overrides:
    
    trimEmptyCollections in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - trimEmptyMaps
```
public XmlSerializerBuilder trimEmptyMaps(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Trim empty maps.
    If true, empty map values will not be serialized to the output.
    See Also:
    - Serializer.SERIALIZER_trimEmptyMaps
    Overrides:
    
    trimEmptyMaps in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - trimEmptyMaps
```
public XmlSerializerBuilder trimEmptyMaps()
```
    Description copied from class: SerializerBuilder
    Configuration property: Trim empty maps.
    Shortcut for calling trimEmptyMaps(true).
    See Also:
    - Serializer.SERIALIZER_trimEmptyMaps
    Overrides:
    
    trimEmptyMaps in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - trimNullProperties
```
public XmlSerializerBuilder trimNullProperties(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Trim null bean property values.
    If true, null bean values will not be serialized to the output.
    See Also:
    - Serializer.SERIALIZER_trimNullProperties
    Overrides:
    
    trimNullProperties in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - trimStrings
```
public XmlSerializerBuilder trimStrings(boolean value)
```
    Description copied from class: SerializerBuilder
    Configuration property: Trim strings.
    If true, string values will be trimmed of whitespace using String.trim() before being serialized.
    See Also:
    - Serializer.SERIALIZER_trimStrings
    Overrides:
    
    trimStrings in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - trimStrings
```
public XmlSerializerBuilder trimStrings()
```
    Description copied from class: SerializerBuilder
    Configuration property: Trim strings.
    Shortcut for calling trimStrings(true).
    See Also:
    - Serializer.SERIALIZER_trimStrings
    Overrides:
    
    trimStrings in class SerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - uriContext
```
public XmlSerializerBuilder uriContext(UriContext value)
```
    Description copied from class: SerializerBuilder
    Configuration property: URI context bean.
    Bean used for resolution of URIs to absolute or root-relative form.
    See Also:
    - Serializer.SERIALIZER_uriContext
    Overrides:
    
    uriContext in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - uriRelativity
```
public XmlSerializerBuilder uriRelativity(UriRelativity value)
```
    Description copied from class: SerializerBuilder
    Configuration property: URI relativity.
    Defines what relative URIs are relative to when serializing URI/URL objects.
    See Also:
    - Serializer.SERIALIZER_uriRelativity
    Overrides:
    
    uriRelativity in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is UriRelativity.RESOURCE
    
    Returns:
    
    This object (for method chaining).
  - uriResolution
```
public XmlSerializerBuilder uriResolution(UriResolution value)
```
    Description copied from class: SerializerBuilder
    Configuration property: URI resolution.
    Defines the resolution level for URIs when serializing URI/URL objects.
    See Also:
    - Serializer.SERIALIZER_uriResolution
    Overrides:
    
    uriResolution in class SerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is UriResolution.NONE
    
    Returns:
    
    This object (for method chaining).
  - beanClassVisibility
```
public XmlSerializerBuilder beanClassVisibility(Visibility value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Minimum bean class visibility.
    Classes are not considered beans unless they meet the minimum visibility requirements.
    For example, if the visibility is PUBLIC and the bean class is protected, then the class will not be interpreted as a bean class and will be treated as a string.
    See Also:
    - BeanContext.BEAN_beanClassVisibility
    Overrides:
    
    beanClassVisibility in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanConstructorVisibility
```
public XmlSerializerBuilder beanConstructorVisibility(Visibility value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Minimum bean constructor visibility.
    Only look for constructors with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanConstructorVisibility
    Overrides:
    
    beanConstructorVisibility in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public XmlSerializerBuilder beanDictionary(boolean append,
                                           Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean dictionary.
    Same as BeanContextBuilder.beanDictionary(Object...) but allows you to optionally overwrite the previous value.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Overrides:
    
    beanDictionary in class WriterSerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to. Otherwise, the previous value is replaced.
    
    values - The new values for this property.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public XmlSerializerBuilder beanDictionary(Class<?>... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean dictionary.
    Same as BeanContextBuilder.beanDictionary(Object...) but takes in an array of classes.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Overrides:
    
    beanDictionary in class WriterSerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionary
```
public XmlSerializerBuilder beanDictionary(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean dictionary.
    Adds to the list of classes that make up the bean dictionary in this bean context.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Overrides:
    
    beanDictionary in class WriterSerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanDictionaryRemove
```
public XmlSerializerBuilder beanDictionaryRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean dictionary.
    Removes from the list of classes that make up the bean dictionary in this bean context.
    See Also:
    - BeanContext.BEAN_beanDictionary
    Overrides:
    
    beanDictionaryRemove in class WriterSerializerBuilder
    
    Parameters:
    
    values - The values to remove from this property.
    
    Returns:
    
    This object (for method chaining).
  - beanFieldVisibility
```
public XmlSerializerBuilder beanFieldVisibility(Visibility value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Minimum bean field visibility.
    Only look for bean fields with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanFieldVisibility
    Overrides:
    
    beanFieldVisibility in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC.
    
    Returns:
    
    This object (for method chaining).
  - beanFilters
```
public XmlSerializerBuilder beanFilters(boolean append,
                                        Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean filters.
    Same as BeanContextBuilder.beanFilters(Object...) but allows you to optionally overwrite the previous value.
    See Also:
    - BeanContext.BEAN_beanFilters
    Overrides:
    
    beanFilters in class WriterSerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to. Otherwise, the previous value is replaced.
    values - The new values for this property.
    Values can consist of any of the following types:
    
    Any bean class that specifies a value for @Bean(typeName).
    Any subclass of BeanDictionaryList containing a collection of bean classes with type name annotations.
    Any subclass of BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - beanFilters
```
public XmlSerializerBuilder beanFilters(Class<?>... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean filters.
    Same as BeanContextBuilder.beanFilters(Object...) but takes in an array of classes.
    See Also:
    - BeanContext.BEAN_beanFilters
    Overrides:
    
    beanFilters in class WriterSerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - beanFilters
```
public XmlSerializerBuilder beanFilters(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean filters.
    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.
    See Also:
    - BeanContext.BEAN_beanFilters
    Overrides:
    
    beanFilters in class WriterSerializerBuilder
    
    Parameters:
    values - The values to add to this property.
    Values can consist of any of the following types:
    
    Any bean class that specifies a value for @Bean(typeName).
    Any subclass of BeanDictionaryList containing a collection of bean classes with type name annotations.
    Any subclass of BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - beanFiltersRemove
```
public XmlSerializerBuilder beanFiltersRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean filters.
    Removes from the list of classes that make up the bean filters in this bean context.
    See Also:
    - BeanContext.BEAN_beanFilters
    Overrides:
    
    beanFiltersRemove in class WriterSerializerBuilder
    
    Parameters:
    values - The values to remove from this property.
    Values can consist of any of the following types:
    
    Any bean class that specifies a value for @Bean(typeName).
    Any subclass of BeanDictionaryList containing a collection of bean classes with type name annotations.
    Any subclass of BeanDictionaryMap containing a mapping of type names to classes without type name annotations.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - beanMapPutReturnsOldValue
```
public XmlSerializerBuilder beanMapPutReturnsOldValue(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: BeanMap.put() returns old property value.
    If true, then the BeanMap.put() method will return old property values.
    Otherwise, it returns null.
    See Also:
    - BeanContext.BEAN_beanMapPutReturnsOldValue
    Overrides:
    
    beanMapPutReturnsOldValue in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beanMapPutReturnsOldValue
```
public XmlSerializerBuilder beanMapPutReturnsOldValue()
```
    Description copied from class: BeanContextBuilder
    Configuration property: BeanMap.put() returns old property value.
    Shortcut for calling beanMapPutReturnsOldValue(true).
    See Also:
    - BeanContext.BEAN_beanMapPutReturnsOldValue
    Overrides:
    
    beanMapPutReturnsOldValue in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - beanMethodVisibility
```
public XmlSerializerBuilder beanMethodVisibility(Visibility value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Minimum bean method visibility.
    Only look for bean methods with the specified minimum visibility.
    See Also:
    - BeanContext.BEAN_beanMethodVisibility
    Overrides:
    
    beanMethodVisibility in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is Visibility.PUBLIC
    
    Returns:
    
    This object (for method chaining).
  - beansRequireDefaultConstructor
```
public XmlSerializerBuilder beansRequireDefaultConstructor(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require no-arg constructors.
    If true, a Java class must implement a default no-arg constructor to be considered a bean.
    Otherwise, the bean will be serialized as a string using the Object.toString() method.
    See Also:
    - BeanContext.BEAN_beansRequireDefaultConstructor
    Overrides:
    
    beansRequireDefaultConstructor in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireDefaultConstructor
```
public XmlSerializerBuilder beansRequireDefaultConstructor()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require no-arg constructors.
    Shortcut for calling beansRequireDefaultConstructor(true).
    See Also:
    - BeanContext.BEAN_beansRequireDefaultConstructor
    Overrides:
    
    beansRequireDefaultConstructor in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSerializable
```
public XmlSerializerBuilder beansRequireSerializable(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require Serializable interface.
    If true, a Java class must implement the Serializable interface to be considered a bean.
    Otherwise, the bean will be serialized as a string using the Object.toString() method.
    See Also:
    - BeanContext.BEAN_beansRequireSerializable
    Overrides:
    
    beansRequireSerializable in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSerializable
```
public XmlSerializerBuilder beansRequireSerializable()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require Serializable interface.
    Shortcut for calling beansRequireSerializable(true).
    See Also:
    - BeanContext.BEAN_beansRequireSerializable
    Overrides:
    
    beansRequireSerializable in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSettersForGetters
```
public XmlSerializerBuilder beansRequireSettersForGetters(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require setters for getters.
    If true, only getters that have equivalent setters will be considered as properties on a bean.
    Otherwise, they will be ignored.
    See Also:
    - BeanContext.BEAN_beansRequireSettersForGetters
    Overrides:
    
    beansRequireSettersForGetters in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSettersForGetters
```
public XmlSerializerBuilder beansRequireSettersForGetters()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require setters for getters.
    Shortcut for calling beansRequireSettersForGetters(true).
    See Also:
    - BeanContext.BEAN_beansRequireSettersForGetters
    Overrides:
    
    beansRequireSettersForGetters in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - beansRequireSomeProperties
```
public XmlSerializerBuilder beansRequireSomeProperties(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Beans require at least one property.
    If true, then a Java class must contain at least 1 property to be considered a bean.
    Otherwise, the bean will be serialized as a string using the Object.toString() method.
    See Also:
    - BeanContext.BEAN_beansRequireSomeProperties
    Overrides:
    
    beansRequireSomeProperties in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - beanTypePropertyName
```
public XmlSerializerBuilder beanTypePropertyName(String value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean type property name.
    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.
    See Also:
    - BeanContext.BEAN_beanTypePropertyName
    Overrides:
    
    beanTypePropertyName in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is "_type".
    
    Returns:
    
    This object (for method chaining).
  - debug
```
public XmlSerializerBuilder debug()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Debug mode.
    Shortcut for calling debug(true).
    See Also:
    - BeanContext.BEAN_debug
    Overrides:
    
    debug in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - example
```
public <T> XmlSerializerBuilder example(Class<T> c,
                                        T o)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO example.
    Specifies an example of the specified class.
    See Also:
    - BeanContext.BEAN_examples
    Overrides:
    
    example in class WriterSerializerBuilder
    
    Parameters:
    
    c - The POJO class.
    
    o - An instance of the POJO class used for examples.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnGetters
```
public XmlSerializerBuilder ignoreInvocationExceptionsOnGetters(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore invocation errors on getters.
    If true, errors thrown when calling bean getter methods will silently be ignored. Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnGetters
    Overrides:
    
    ignoreInvocationExceptionsOnGetters in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnGetters
```
public XmlSerializerBuilder ignoreInvocationExceptionsOnGetters()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore invocation errors on getters.
    Shortcut for calling ignoreInvocationExceptionsOnGetters(true).
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnGetters
    Overrides:
    
    ignoreInvocationExceptionsOnGetters in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnSetters
```
public XmlSerializerBuilder ignoreInvocationExceptionsOnSetters(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore invocation errors on setters.
    If true, errors thrown when calling bean setter methods will silently be ignored.
    Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnSetters
    Overrides:
    
    ignoreInvocationExceptionsOnSetters in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreInvocationExceptionsOnSetters
```
public XmlSerializerBuilder ignoreInvocationExceptionsOnSetters()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore invocation errors on setters.
    Shortcut for calling ignoreInvocationExceptionsOnSetters(true).
    See Also:
    - BeanContext.BEAN_ignoreInvocationExceptionsOnSetters
    Overrides:
    
    ignoreInvocationExceptionsOnSetters in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - ignorePropertiesWithoutSetters
```
public XmlSerializerBuilder ignorePropertiesWithoutSetters(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore properties without setters.
    If true, trying to set a value on a bean property without a setter will silently be ignored.
    Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignorePropertiesWithoutSetters
    Overrides:
    
    ignorePropertiesWithoutSetters in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownBeanProperties
```
public XmlSerializerBuilder ignoreUnknownBeanProperties(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore unknown properties.
    If true, trying to set a value on a non-existent bean property will silently be ignored.
    Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignoreUnknownBeanProperties
    Overrides:
    
    ignoreUnknownBeanProperties in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownBeanProperties
```
public XmlSerializerBuilder ignoreUnknownBeanProperties()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore unknown properties.
    Shortcut for calling ignoreUnknownBeanProperties(true).
    See Also:
    - BeanContext.BEAN_ignoreUnknownBeanProperties
    Overrides:
    
    ignoreUnknownBeanProperties in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - ignoreUnknownNullBeanProperties
```
public XmlSerializerBuilder ignoreUnknownNullBeanProperties(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Ignore unknown properties with null values.
    If true, trying to set a null value on a non-existent bean property will silently be ignored.
    Otherwise, a BeanRuntimeException is thrown.
    See Also:
    - BeanContext.BEAN_ignoreUnknownNullBeanProperties
    Overrides:
    
    ignoreUnknownNullBeanProperties in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - implClass
```
public <T> XmlSerializerBuilder implClass(Class<T> interfaceClass,
                                          Class<? extends T> implClass)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Implementation classes.
    See Also:
    - BeanContext.BEAN_implClasses
    Overrides:
    
    implClass in class WriterSerializerBuilder
    
    Type Parameters:
    
    T - The class type of the interface.
    
    Parameters:
    
    interfaceClass - The interface class.
    
    implClass - The implementation class.
    
    Returns:
    
    This object (for method chaining).
  - implClasses
```
public XmlSerializerBuilder implClasses(Map<String,Class<?>> values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Implementation classes.
    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).
    See Also:
    - BeanContext.BEAN_implClasses
    Overrides:
    
    implClasses in class WriterSerializerBuilder
    
    Parameters:
    
    values - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - locale
```
public XmlSerializerBuilder locale(Locale value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Locale.
    Specifies a default locale for serializer and parser sessions.
    See Also:
    - BeanContext.BEAN_locale
    Overrides:
    
    locale in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - mediaType
```
public XmlSerializerBuilder mediaType(MediaType value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Media type.
    Specifies a default media type value for serializer and parser sessions.
    See Also:
    - BeanContext.BEAN_mediaType
    Overrides:
    
    mediaType in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanClasses
```
public XmlSerializerBuilder notBeanClasses(boolean append,
                                           Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean class exclusions.
    Not-bean classes are converted to Strings during serialization even if they appear to be bean-like.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    Overrides:
    
    notBeanClasses in class WriterSerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to.
    Otherwise, the previous value is replaced.
    values - The new value for this property.
    Values can consist of any of the following types:
    
    Classes.
    Arrays and collections of classes.
    Returns:
    
    This object (for method chaining).
  - notBeanClasses
```
public XmlSerializerBuilder notBeanClasses(Class<?>... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean class exclusions.
    List of classes that should not be treated as beans even if they appear to be bean-like.
    Not-bean classes are converted to Strings during serialization.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    Overrides:
    
    notBeanClasses in class WriterSerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanClasses
```
public XmlSerializerBuilder notBeanClasses(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean class exclusions.
    List of classes that should not be treated as beans even if they appear to be bean-like.
    Not-bean classes are converted to Strings during serialization.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    Overrides:
    
    notBeanClasses in class WriterSerializerBuilder
    
    Parameters:
    values - The values to add to this property.
    Values can consist of any of the following types:
    
    Classes.
    Arrays and collections of classes.
    Returns:
    
    This object (for method chaining).
  - notBeanClassesRemove
```
public XmlSerializerBuilder notBeanClassesRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean class exclusions.
    See Also:
    - BeanContext.BEAN_notBeanClasses
    Overrides:
    
    notBeanClassesRemove in class WriterSerializerBuilder
    
    Parameters:
    values - The values to remove from this property.
    Values can consist of any of the following types:
    
    Classes.
    Arrays and collections of classes.
    Returns:
    
    This object (for method chaining).
  - notBeanPackages
```
public XmlSerializerBuilder notBeanPackages(boolean append,
                                            Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean package exclusions.
    When specified, the current list of ignore packages are appended to.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Overrides:
    
    notBeanPackages in class WriterSerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to.
    Otherwise, the previous value is replaced.
    values - The new values for this property.
    Values can consist of any of the following types:
    
    Classes.
    Arrays and collections of classes.
    Returns:
    
    This object (for method chaining).
  - notBeanPackages
```
public XmlSerializerBuilder notBeanPackages(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Overrides:
    
    notBeanPackages in class WriterSerializerBuilder
    
    Parameters:
    values - The values to add to this property.
    Values can consist of any of the following types:
    
    Strings.
    Arrays and collections of strings.
    Returns:
    
    This object (for method chaining).
  - notBeanPackages
```
public XmlSerializerBuilder notBeanPackages(String... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Overrides:
    
    notBeanPackages in class WriterSerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - notBeanPackagesRemove
```
public XmlSerializerBuilder notBeanPackagesRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Bean package exclusions.
    See Also:
    - BeanContext.BEAN_notBeanPackages
    Overrides:
    
    notBeanPackagesRemove in class WriterSerializerBuilder
    
    Parameters:
    values -
    Values can consist of any of the following types:
    Possible values are:
    
    Strings.
    Arrays and collections of strings.
    Returns:
    
    This object (for method chaining).
  - pojoSwaps
```
public XmlSerializerBuilder pojoSwaps(boolean append,
                                      Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO swaps.
    POJO swaps are used to "swap out" non-serializable classes with serializable equivalents during serialization, and "swap in" the non-serializable class during parsing.
    An example of a POJO swap would be a Calendar object that gets swapped out for an ISO8601 string.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Overrides:
    
    pojoSwaps in class WriterSerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to.
    Otherwise, the previous value is replaced.
    values - The new value for this property.
    Values can consist of any of the following types:
    
    Strings.
    Arrays and collections of strings.
    Returns:
    
    This object (for method chaining).
  - pojoSwaps
```
public XmlSerializerBuilder pojoSwaps(Class<?>... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Overrides:
    
    pojoSwaps in class WriterSerializerBuilder
    
    Parameters:
    
    values - The values to add to this property.
    
    Returns:
    
    This object (for method chaining).
  - pojoSwaps
```
public XmlSerializerBuilder pojoSwaps(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Overrides:
    
    pojoSwaps in class WriterSerializerBuilder
    
    Parameters:
    values - The values to add to this property.
    Values can consist of any of the following types:
    
    Any subclass of PojoSwap.
    Any surrogate class. A shortcut for defining a SurrogateSwap.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - pojoSwapsRemove
```
public XmlSerializerBuilder pojoSwapsRemove(Object... values)
```
    Description copied from class: BeanContextBuilder
    Configuration property: POJO swaps.
    See Also:
    - BeanContext.BEAN_pojoSwaps
    Overrides:
    
    pojoSwapsRemove in class WriterSerializerBuilder
    
    Parameters:
    values - The values to remove from this property.
    Values can consist of any of the following types:
    
    Any subclass of PojoSwap.
    Any surrogate class. A shortcut for defining a SurrogateSwap.
    Any array or collection of the objects above.
    Returns:
    
    This object (for method chaining).
  - sortProperties
```
public XmlSerializerBuilder sortProperties(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Sort bean properties.
    When true, all bean properties will be serialized and access in alphabetical order. Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor.
    See Also:
    - BeanContext.BEAN_sortProperties
    Overrides:
    
    sortProperties in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - sortProperties
```
public XmlSerializerBuilder sortProperties()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Sort bean properties.
    Shortcut for calling sortProperties(true).
    See Also:
    - BeanContext.BEAN_sortProperties
    Overrides:
    
    sortProperties in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - timeZone
```
public XmlSerializerBuilder timeZone(TimeZone value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: TimeZone.
    See Also:
    - BeanContext.BEAN_timeZone
    Overrides:
    
    timeZone in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    
    Returns:
    
    This object (for method chaining).
  - useEnumNames
```
public XmlSerializerBuilder useEnumNames()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Use enum names.
    When enabled, enums are always serialized by name instead of using Object.toString().
    See Also:
    - BeanContext.BEAN_useEnumNames
    Overrides:
    
    useEnumNames in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - useInterfaceProxies
```
public XmlSerializerBuilder useInterfaceProxies(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Use interface proxies.
    If true, then interfaces will be instantiated as proxy classes through the use of an InvocationHandler if there is no other way of instantiating them.
    See Also:
    - BeanContext.BEAN_useInterfaceProxies
    Overrides:
    
    useInterfaceProxies in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is true.
    
    Returns:
    
    This object (for method chaining).
  - useJavaBeanIntrospector
```
public XmlSerializerBuilder useJavaBeanIntrospector(boolean value)
```
    Description copied from class: BeanContextBuilder
    Configuration property: Use Java Introspector.
    Using the built-in Java bean introspector will not pick up fields or non-standard getters/setters.
    Notes:
    - Most @Bean annotations will be ignored if you enable this setting.
    See Also:
    - BeanContext.BEAN_useJavaBeanIntrospector
    Overrides:
    
    useJavaBeanIntrospector in class WriterSerializerBuilder
    
    Parameters:
    
    value - The new value for this property.
    The default is false.
    
    Returns:
    
    This object (for method chaining).
  - useJavaBeanIntrospector
```
public XmlSerializerBuilder useJavaBeanIntrospector()
```
    Description copied from class: BeanContextBuilder
    Configuration property: Use Java Introspector.
    Shortcut for calling useJavaBeanIntrospector(true).
    See Also:
    - BeanContext.BEAN_useJavaBeanIntrospector
    Overrides:
    
    useJavaBeanIntrospector in class WriterSerializerBuilder
    
    Returns:
    
    This object (for method chaining).
  - set
```
public XmlSerializerBuilder set(String name,
                                Object value)
```
    Description copied from class: ContextBuilder
    
    Sets a configuration property on this object.
    
    Overrides:
    
    set in class WriterSerializerBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(String, Object)
  - set
```
public XmlSerializerBuilder set(boolean append,
                                String name,
                                Object value)
```
    Description copied from class: ContextBuilder
    
    Sets or adds to a SET or LIST property.
    
    Overrides:
    
    set in class WriterSerializerBuilder
    
    Parameters:
    
    append - If true, the previous value is appended to. Otherwise, the previous value is replaced.
    
    name - The property name.
    
    value - The property value.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(String, Object)
  - set
```
public XmlSerializerBuilder set(Map<String,Object> properties)
```
    Description copied from class: ContextBuilder
    
    Sets multiple configuration properties on this object.
    
    Overrides:
    
    set in class WriterSerializerBuilder
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.set(java.util.Map)
  - add
```
public XmlSerializerBuilder add(Map<String,Object> properties)
```
    Description copied from class: ContextBuilder
    
    Adds multiple configuration properties on this object.
    
    Overrides:
    
    add in class WriterSerializerBuilder
    
    Parameters:
    
    properties - The properties to set on this class.
    
    Returns:
    
    This object (for method chaining).
    
    See Also:
    
    PropertyStoreBuilder.add(java.util.Map)
  - addTo
```
public XmlSerializerBuilder addTo(String name,
                                  Object value)
```
    Description copied from class: ContextBuilder
    
    Adds a value to a SET or LIST property.
    
    Overrides:
    
    addTo in class WriterSerializerBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The new value to add to the SET property.
    
    Returns:
    
    This object (for method chaining).
  - addTo
```
public XmlSerializerBuilder addTo(String name,
                                  String key,
                                  Object value)
```
    Description copied from class: ContextBuilder
    
    Adds or overwrites a value to a SET, LIST, or MAP property.
    
    Overrides:
    
    addTo in class WriterSerializerBuilder
    
    Parameters:
    
    name - The property name.
    
    key - The property value map key.
    
    value - The property value map value.
    
    Returns:
    
    This object (for method chaining).
  - removeFrom
```
public XmlSerializerBuilder removeFrom(String name,
                                       Object value)
```
    Description copied from class: ContextBuilder
    
    Removes a value from a SET, LIST, or MAP property.
    
    Overrides:
    
    removeFrom in class WriterSerializerBuilder
    
    Parameters:
    
    name - The property name.
    
    value - The property value in the SET property.
    
    Returns:
    
    This object (for method chaining).
  - apply
```
public XmlSerializerBuilder apply(PropertyStore copyFrom)
```
    Description copied from class: ContextBuilder
    
    Copies the settings from the specified property store into this builder.
    
    Overrides:
    
    apply in class WriterSerializerBuilder
    
    Parameters:
    
    copyFrom - The factory whose settings are being copied.
    
    Returns:
    
    This object (for method chaining).
  - abridged
```
@Deprecated
public XmlSerializerBuilder abridged(boolean value)
```
    Deprecated. Use Serializer.SERIALIZER_addRootType.
    
    Overrides:
    
    abridged in class SerializerBuilder
  - abridged
```
@Deprecated
public XmlSerializerBuilder abridged()
```
    Deprecated. Use Serializer.SERIALIZER_addRootType.
    
    Overrides:
    
    abridged in class SerializerBuilder
  - addBeanTypeProperties
```
@Deprecated
public XmlSerializerBuilder addBeanTypeProperties(boolean value)
```
    Deprecated. addBeanTypes(boolean)
    
    Overrides:
    
    addBeanTypeProperties in class SerializerBuilder

Class XmlSerializerBuilder

Field Summary

Fields inherited from class org.apache.juneau.ContextBuilder

Constructor Summary

Method Summary

Methods inherited from class org.apache.juneau.serializer.SerializerBuilder

Methods inherited from class org.apache.juneau.BeanContextBuilder

Methods inherited from class org.apache.juneau.ContextBuilder

Methods inherited from class java.lang.Object

Constructor Detail

XmlSerializerBuilder

XmlSerializerBuilder

Method Detail

build

addNamespaceUrisToRoot

See Also:

addNamespaceUrisToRoot

See Also:

autoDetectNamespaces

See Also:

defaultNamespace

See Also:

enableNamespaces

See Also:

enableNamespaces

See Also:

ns

See Also:

namespaces

See Also:

xsNamespace

See Also:

maxIndent

See Also:

quoteChar

See Also:

sq

See Also:

useWhitespace

See Also:

useWhitespace

See Also:

ws

See Also:

addBeanTypes

See Also:

addBeanTypes

See Also:

addRootType

See Also:

addRootType

See Also:

detectRecursions

Notes:

See Also:

detectRecursions

See Also:

ignoreRecursions

Notes:

See Also:

ignoreRecursions

See Also:

initialDepth

See Also:

listener

See Also:

maxDepth

See Also:

sortCollections

See Also:

sortCollections

See Also:

sortMaps

See Also:

sortMaps

See Also:

trimEmptyCollections

See Also:

trimEmptyCollections

See Also: