org.apache.juneau.xml.XmlSerializer Maven / Gradle / Ivy
// ***************************************************************************************************************************
// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file *
// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *
// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *
// * with the License. You may obtain a copy of the License at *
// * *
// * http://www.apache.org/licenses/LICENSE-2.0 *
// * *
// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *
// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *
// * specific language governing permissions and limitations under the License. *
// ***************************************************************************************************************************
package org.apache.juneau.xml;
import static org.apache.juneau.collections.JsonMap.*;
import static org.apache.juneau.internal.CollectionUtils.*;
import java.lang.annotation.*;
import java.lang.reflect.*;
import java.nio.charset.*;
import java.util.*;
import java.util.concurrent.*;
import org.apache.juneau.*;
import org.apache.juneau.collections.*;
import org.apache.juneau.internal.*;
import org.apache.juneau.json.*;
import org.apache.juneau.serializer.*;
import org.apache.juneau.utils.*;
/**
* Serializes POJO models to XML.
*
* Media types
*
* Handles Accept types: text/xml
*
* Produces Content-Type types: text/xml
*
*
Description
*
* See the {@link JsonSerializer} class for details on how Java models map to JSON.
*
*
* For example, the following JSON...
*
* {
* name:'John Smith' ,
* address: {
* streetAddress: '21 2nd Street' ,
* city: 'New York' ,
* state: 'NY' ,
* postalCode: 10021
* },
* phoneNumbers: [
* '212 555-1111' ,
* '212 555-2222'
* ],
* additionalInfo: null ,
* remote: false ,
* height: 62.4 ,
* 'fico score' : ' > 640'
* }
*
* ...maps to the following XML using the default serializer...
*
* <object>
* <name> John Smith</name>
* <address>
* <streetAddress> 21 2nd Street</streetAddress>
* <city> New York</city>
* <state> NY</state>
* <postalCode> 10021</postalCode>
* </address>
* <phoneNumbers>
* <string> 212 555-1111</string>
* <string> 212 555-2222</string>
* </phoneNumbers>
* <additionalInfo _type ='null' ></additionalInfo>
* <remote> false</remote>
* <height> 62.4</height>
* <fico_x0020_score> > 640</fico_x0020_score>
* </object>
*
*
* An additional "add-json-properties" mode is also provided to prevent loss of JSON data types...
*
* <object>
* <name _type ='string' > John Smith</name>
* <address _type ='object' >
* <streetAddress _type ='string' > 21 2nd Street</streetAddress>
* <city _type ='string' > New York</city>
* <state _type ='string' > NY</state>
* <postalCode _type ='number' > 10021</postalCode>
* </address>
* <phoneNumbers _type ='array' >
* <string> 212 555-1111</string>
* <string> 212 555-2222</string>
* </phoneNumbers>
* <additionalInfo _type ='null' ></additionalInfo>
* <remote _type ='boolean' > false</remote>
* <height _type ='number' > 62.4</height>
* <fico_x0020_score _type ='string' > > 640</fico_x0020_score>
* </object>
*
*
*
* This serializer provides several serialization options.
* Typically, one of the predefined DEFAULT serializers will be sufficient.
* However, custom serializers can be constructed to fine-tune behavior.
*
*
* If an attribute name contains any non-valid XML element characters, they will be escaped using standard
* {@code _x####_} notation.
*
*
Behavior-specific subclasses
*
* The following direct subclasses are provided for convenience:
*
* - {@link Sq} - Default serializer, single quotes.
*
- {@link SqReadable} - Default serializer, single quotes, whitespace added.
*
*
* Notes:
* - This class is thread safe and reusable.
*
*
* See Also:
* - XML Details
*
*/
public class XmlSerializer extends WriterSerializer implements XmlMetaProvider {
//-------------------------------------------------------------------------------------------------------------------
// Static
//-------------------------------------------------------------------------------------------------------------------
private static final Namespace[] EMPTY_NAMESPACE_ARRAY = {};
/** Default serializer without namespaces. */
public static final XmlSerializer DEFAULT = new XmlSerializer(create());
/** Default serializer without namespaces, with single quotes. */
public static final XmlSerializer DEFAULT_SQ = new Sq(create());
/** Default serializer without namespaces, with single quotes, whitespace added. */
public static final XmlSerializer DEFAULT_SQ_READABLE = new SqReadable(create());
/** Default serializer, all default settings. */
public static final XmlSerializer DEFAULT_NS = new Ns(create());
/** Default serializer, single quotes. */
public static final XmlSerializer DEFAULT_NS_SQ = new NsSq(create());
/** Default serializer, single quotes, whitespace added. */
public static final XmlSerializer DEFAULT_NS_SQ_READABLE = new NsSqReadable(create());
/**
* Creates a new builder for this object.
*
* @return A new builder.
*/
public static Builder create() {
return new Builder();
}
//-------------------------------------------------------------------------------------------------------------------
// Static subclasses
//-------------------------------------------------------------------------------------------------------------------
/** Default serializer, single quotes. */
public static class Sq extends XmlSerializer {
/**
* Constructor.
*
* @param builder The builder for this object.
*/
public Sq(Builder builder) {
super(builder.quoteChar('\''));
}
}
/** Default serializer, single quotes, whitespace added. */
public static class SqReadable extends XmlSerializer {
/**
* Constructor.
*
* @param builder The builder for this object.
*/
public SqReadable(Builder builder) {
super(builder.quoteChar('\'').useWhitespace());
}
}
/** Default serializer without namespaces. */
public static class Ns extends XmlSerializer {
/**
* Constructor.
*
* @param builder The builder for this object.
*/
public Ns(Builder builder) {
super(builder.enableNamespaces());
}
}
/** Default serializer without namespaces, single quotes. */
public static class NsSq extends XmlSerializer {
/**
* Constructor.
*
* @param builder The builder for this object.
*/
public NsSq(Builder builder) {
super(builder.enableNamespaces().quoteChar('\''));
}
}
/** Default serializer without namespaces, single quotes, with whitespace. */
public static class NsSqReadable extends XmlSerializer {
/**
* Constructor.
*
* @param builder The builder for this object.
*/
public NsSqReadable(Builder builder) {
super(builder.enableNamespaces().quoteChar('\'').useWhitespace());
}
}
@SuppressWarnings("javadoc")
protected static final Namespace
DEFAULT_JUNEAU_NAMESPACE = Namespace.of("juneau", "http://www.apache.org/2013/Juneau"),
DEFAULT_XS_NAMESPACE = Namespace.of("xs", "http://www.w3.org/2001/XMLSchema");
//-------------------------------------------------------------------------------------------------------------------
// Builder
//-------------------------------------------------------------------------------------------------------------------
/**
* Builder class.
*/
@FluentSetters
public static class Builder extends WriterSerializer.Builder {
private static final Cache CACHE = Cache.of(HashKey.class, XmlSerializer.class).build();
boolean addBeanTypesXml, addNamespaceUrisToRoot, disableAutoDetectNamespaces, enableNamespaces;
Namespace defaultNamespace;
List namespaces;
/**
* Constructor, default settings.
*/
protected Builder() {
produces("text/xml");
addBeanTypesXml = env("XmlSerializer.addBeanTypes", false);
addNamespaceUrisToRoot = env("XmlSerializer.addNamespaceUrisToRoot", false);
disableAutoDetectNamespaces = env("XmlSerializer.disableAutoDetectNamespaces", false);
enableNamespaces = env("XmlSerializer.enableNamespaces", false);
defaultNamespace = null;
namespaces = null;
}
/**
* Copy constructor.
*
* @param copyFrom The bean to copy from.
*/
protected Builder(XmlSerializer copyFrom) {
super(copyFrom);
addBeanTypesXml = copyFrom.addBeanTypesXml;
addNamespaceUrisToRoot = copyFrom.addNamespaceUrlsToRoot;
disableAutoDetectNamespaces = ! copyFrom.autoDetectNamespaces;
enableNamespaces = copyFrom.enableNamespaces;
defaultNamespace = copyFrom.defaultNamespace;
namespaces = copyFrom.namespaces.length == 0 ? null : list(copyFrom.namespaces);
}
/**
* Copy constructor.
*
* @param copyFrom The builder to copy from.
*/
protected Builder(Builder copyFrom) {
super(copyFrom);
addBeanTypesXml = copyFrom.addBeanTypesXml;
addNamespaceUrisToRoot = copyFrom.addNamespaceUrisToRoot;
disableAutoDetectNamespaces = copyFrom.disableAutoDetectNamespaces;
enableNamespaces = copyFrom.enableNamespaces;
defaultNamespace = copyFrom.defaultNamespace;
namespaces = copyOf(copyFrom.namespaces);
}
@Override /* Context.Builder */
public Builder copy() {
return new Builder(this);
}
@Override /* Context.Builder */
public XmlSerializer build() {
return cache(CACHE).build(XmlSerializer.class);
}
@Override /* Context.Builder */
public HashKey hashKey() {
return HashKey.of(
super.hashKey(),
addBeanTypesXml,
addNamespaceUrisToRoot,
disableAutoDetectNamespaces,
enableNamespaces,
defaultNamespace,
namespaces
);
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* Add "_type" properties when needed.
*
*
* If true , then "_type" properties will be added to beans if their type cannot be inferred
* through reflection.
*
*
* When present, this value overrides the {@link org.apache.juneau.serializer.Serializer.Builder#addBeanTypes()} setting and is
* provided to customize the behavior of specific serializers in a {@link SerializerSet}.
*
* @return This object.
*/
@FluentSetter
public Builder addBeanTypesXml() {
return addBeanTypesXml(true);
}
/**
* Same as {@link #addBeanTypesXml()} but allows you to explicitly specify the value.
*
* @param value The value for this setting.
* @return This object.
*/
@FluentSetter
public Builder addBeanTypesXml(boolean value) {
addBeanTypesXml = value;
return this;
}
/**
* Add namespace URLs to the root element.
*
*
* Use this setting to add {@code xmlns:x} attributes to the root element for the default and all mapped namespaces.
*
*
* This setting is ignored if {@link #enableNamespaces()} is not enabled.
*
*
See Also:
* - Namespaces
*
*
* @return This object.
*/
@FluentSetter
public Builder addNamespaceUrisToRoot() {
return addNamespaceUrisToRoot(true);
}
/**
* Same as {@link #addNamespaceUrisToRoot()} but allows you to explicitly specify the value.
*
* @param value The value for this setting.
* @return This object.
*/
@FluentSetter
public Builder addNamespaceUrisToRoot(boolean value) {
addNamespaceUrisToRoot = value;
return this;
}
/**
* Don't auto-detect namespace usage.
*
*
* Don't detect namespace usage before serialization.
*
*
* Used in conjunction with {@link Builder#addNamespaceUrisToRoot()} to reduce the list of namespace URLs appended to the
* root element to only those that will be used in the resulting document.
*
*
* If disabled, then the data structure will first be crawled looking for namespaces that will be encountered before
* the root element is serialized.
*
*
* This setting is ignored if {@link Builder#enableNamespaces()} is not enabled.
*
*
Notes:
* -
* Auto-detection of namespaces can be costly performance-wise.
*
In high-performance environments, it's recommended that namespace detection be
* disabled, and that namespaces be manually defined through the {@link Builder#namespaces(Namespace...)} property.
*
*
* See Also:
* - Namespaces
*
*
* @return This object.
*/
@FluentSetter
public Builder disableAutoDetectNamespaces() {
return disableAutoDetectNamespaces(true);
}
/**
* Same as {@link #disableAutoDetectNamespaces()} but allows you to explicitly specify the value.
*
* @param value The value for this setting.
* @return This object.
*/
@FluentSetter
public Builder disableAutoDetectNamespaces(boolean value) {
disableAutoDetectNamespaces = value;
return this;
}
/**
* Default namespace.
*
*
* Specifies the default namespace URI for this document.
*
*
See Also:
* - Namespaces
*
*
* @param value
* The new value for this property.
*
The default is "juneau: http://www.apache.org/2013/Juneau" .
* @return This object.
*/
@FluentSetter
public Builder defaultNamespace(Namespace value) {
defaultNamespace = value;
return this;
}
/**
* Enable support for XML namespaces.
*
*
* If not enabled, XML output will not contain any namespaces regardless of any other settings.
*
*
See Also:
* - Namespaces
*
*
* @return This object.
*/
@FluentSetter
public Builder enableNamespaces() {
return enableNamespaces(true);
}
/**
* Same as {@link #enableNamespaces()} but allows you to explicitly specify the value.
*
* @param value The value for this setting.
* @return This object.
*/
@FluentSetter
public Builder enableNamespaces(boolean value) {
enableNamespaces = value;
return this;
}
/**
* Enable support for XML namespaces.
*
*
* Shortcut for calling enableNamespaces(true ).
*
* @return This object.
*/
@FluentSetter
public Builder ns() {
return enableNamespaces();
}
/**
* Default namespaces.
*
*
* The default list of namespaces associated with this serializer.
*
* @param values The new value for this property.
* @return This object.
*/
@FluentSetter
public Builder namespaces(Namespace...values) {
namespaces = addAll(namespaces, values);
return this;
}
//
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder annotations(Annotation...values) {
super.annotations(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder apply(AnnotationWorkList work) {
super.apply(work);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder applyAnnotations(java.lang.Class...fromClasses) {
super.applyAnnotations(fromClasses);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder applyAnnotations(Method...fromMethods) {
super.applyAnnotations(fromMethods);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder cache(Cache value) {
super.cache(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder debug() {
super.debug();
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder debug(boolean value) {
super.debug(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder impl(Context value) {
super.impl(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.Context.Builder */
public Builder type(Class value) {
super.type(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanClassVisibility(Visibility value) {
super.beanClassVisibility(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanConstructorVisibility(Visibility value) {
super.beanConstructorVisibility(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanContext(BeanContext value) {
super.beanContext(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanContext(BeanContext.Builder value) {
super.beanContext(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanDictionary(java.lang.Class...values) {
super.beanDictionary(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanFieldVisibility(Visibility value) {
super.beanFieldVisibility(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanInterceptor(Class on, Class> value) {
super.beanInterceptor(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanMapPutReturnsOldValue() {
super.beanMapPutReturnsOldValue();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanMethodVisibility(Visibility value) {
super.beanMethodVisibility(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanProperties(Map values) {
super.beanProperties(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanProperties(Class beanClass, String properties) {
super.beanProperties(beanClass, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanProperties(String beanClassName, String properties) {
super.beanProperties(beanClassName, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesExcludes(Map values) {
super.beanPropertiesExcludes(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesExcludes(Class beanClass, String properties) {
super.beanPropertiesExcludes(beanClass, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesExcludes(String beanClassName, String properties) {
super.beanPropertiesExcludes(beanClassName, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesReadOnly(Map values) {
super.beanPropertiesReadOnly(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesReadOnly(Class beanClass, String properties) {
super.beanPropertiesReadOnly(beanClass, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesReadOnly(String beanClassName, String properties) {
super.beanPropertiesReadOnly(beanClassName, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesWriteOnly(Map values) {
super.beanPropertiesWriteOnly(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesWriteOnly(Class beanClass, String properties) {
super.beanPropertiesWriteOnly(beanClass, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beanPropertiesWriteOnly(String beanClassName, String properties) {
super.beanPropertiesWriteOnly(beanClassName, properties);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beansRequireDefaultConstructor() {
super.beansRequireDefaultConstructor();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beansRequireSerializable() {
super.beansRequireSerializable();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder beansRequireSettersForGetters() {
super.beansRequireSettersForGetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder dictionaryOn(Class on, java.lang.Class...values) {
super.dictionaryOn(on, values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableBeansRequireSomeProperties() {
super.disableBeansRequireSomeProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableIgnoreMissingSetters() {
super.disableIgnoreMissingSetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableIgnoreTransientFields() {
super.disableIgnoreTransientFields();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableIgnoreUnknownNullBeanProperties() {
super.disableIgnoreUnknownNullBeanProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder disableInterfaceProxies() {
super.disableInterfaceProxies();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder example(Class pojoClass, T o) {
super.example(pojoClass, o);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder example(Class pojoClass, String json) {
super.example(pojoClass, json);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder findFluentSetters() {
super.findFluentSetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder findFluentSetters(Class on) {
super.findFluentSetters(on);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder ignoreInvocationExceptionsOnGetters() {
super.ignoreInvocationExceptionsOnGetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder ignoreInvocationExceptionsOnSetters() {
super.ignoreInvocationExceptionsOnSetters();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder ignoreUnknownBeanProperties() {
super.ignoreUnknownBeanProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder ignoreUnknownEnumValues() {
super.ignoreUnknownEnumValues();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder implClass(Class interfaceClass, Class implClass) {
super.implClass(interfaceClass, implClass);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder implClasses(Map,Class> values) {
super.implClasses(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder interfaceClass(Class on, Class value) {
super.interfaceClass(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder interfaces(java.lang.Class...value) {
super.interfaces(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder locale(Locale value) {
super.locale(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder mediaType(MediaType value) {
super.mediaType(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder notBeanClasses(java.lang.Class...values) {
super.notBeanClasses(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder notBeanPackages(String...values) {
super.notBeanPackages(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder propertyNamer(Class value) {
super.propertyNamer(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder propertyNamer(Class on, Class value) {
super.propertyNamer(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder sortProperties() {
super.sortProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder sortProperties(java.lang.Class...on) {
super.sortProperties(on);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder stopClass(Class on, Class value) {
super.stopClass(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder swap(Class normalClass, Class swappedClass, ThrowingFunction swapFunction) {
super.swap(normalClass, swappedClass, swapFunction);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder swap(Class normalClass, Class swappedClass, ThrowingFunction swapFunction, ThrowingFunction unswapFunction) {
super.swap(normalClass, swappedClass, swapFunction, unswapFunction);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder swaps(java.lang.Class...values) {
super.swaps(values);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder timeZone(TimeZone value) {
super.timeZone(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder typeName(Class on, String value) {
super.typeName(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder typePropertyName(String value) {
super.typePropertyName(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder typePropertyName(Class on, String value) {
super.typePropertyName(on, value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder useEnumNames() {
super.useEnumNames();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanContextable.Builder */
public Builder useJavaBeanIntrospector() {
super.useJavaBeanIntrospector();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder detectRecursions() {
super.detectRecursions();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder detectRecursions(boolean value) {
super.detectRecursions(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder ignoreRecursions() {
super.ignoreRecursions();
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder ignoreRecursions(boolean value) {
super.ignoreRecursions(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder initialDepth(int value) {
super.initialDepth(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.BeanTraverseContext.Builder */
public Builder maxDepth(int value) {
super.maxDepth(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder accept(String value) {
super.accept(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder addBeanTypes() {
super.addBeanTypes();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder addBeanTypes(boolean value) {
super.addBeanTypes(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder addRootType() {
super.addRootType();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder addRootType(boolean value) {
super.addRootType(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder keepNullProperties() {
super.keepNullProperties();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder keepNullProperties(boolean value) {
super.keepNullProperties(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder listener(Class value) {
super.listener(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder produces(String value) {
super.produces(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder sortCollections() {
super.sortCollections();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder sortCollections(boolean value) {
super.sortCollections(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder sortMaps() {
super.sortMaps();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder sortMaps(boolean value) {
super.sortMaps(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimEmptyCollections() {
super.trimEmptyCollections();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimEmptyCollections(boolean value) {
super.trimEmptyCollections(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimEmptyMaps() {
super.trimEmptyMaps();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimEmptyMaps(boolean value) {
super.trimEmptyMaps(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimStrings() {
super.trimStrings();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder trimStrings(boolean value) {
super.trimStrings(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder uriContext(UriContext value) {
super.uriContext(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder uriRelativity(UriRelativity value) {
super.uriRelativity(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.Serializer.Builder */
public Builder uriResolution(UriResolution value) {
super.uriResolution(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder fileCharset(Charset value) {
super.fileCharset(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder maxIndent(int value) {
super.maxIndent(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder quoteChar(char value) {
super.quoteChar(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder quoteCharOverride(char value) {
super.quoteCharOverride(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder sq() {
super.sq();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder streamCharset(Charset value) {
super.streamCharset(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder useWhitespace() {
super.useWhitespace();
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder useWhitespace(boolean value) {
super.useWhitespace(value);
return this;
}
@Override /* GENERATED - org.apache.juneau.serializer.WriterSerializer.Builder */
public Builder ws() {
super.ws();
return this;
}
//
}
//-------------------------------------------------------------------------------------------------------------------
// Instance
//-------------------------------------------------------------------------------------------------------------------
final boolean
autoDetectNamespaces,
enableNamespaces,
addNamespaceUrlsToRoot,
addBeanTypesXml;
final Namespace defaultNamespace;
final Namespace[] namespaces;
private final boolean addBeanTypes;
private final Map,XmlClassMeta> xmlClassMetas = new ConcurrentHashMap<>();
private final Map,XmlBeanMeta> xmlBeanMetas = new ConcurrentHashMap<>();
private final Map xmlBeanPropertyMetas = new ConcurrentHashMap<>();
/**
* Constructor.
*
* @param builder
* The builder for this object.
*/
public XmlSerializer(Builder builder) {
super(builder);
autoDetectNamespaces = ! builder.disableAutoDetectNamespaces;
enableNamespaces = builder.enableNamespaces;
addNamespaceUrlsToRoot = builder.addNamespaceUrisToRoot;
addBeanTypesXml = builder.addBeanTypesXml;
defaultNamespace = builder.defaultNamespace != null ? builder.defaultNamespace : DEFAULT_JUNEAU_NAMESPACE;
namespaces = builder.namespaces != null ? builder.namespaces.toArray(EMPTY_NAMESPACE_ARRAY) : EMPTY_NAMESPACE_ARRAY;
addBeanTypes = addBeanTypesXml || super.isAddBeanTypes();
}
@Override /* Context */
public Builder copy() {
return new Builder(this);
}
@Override /* Context */
public XmlSerializerSession.Builder createSession() {
return XmlSerializerSession.create(this);
}
@Override /* Context */
public XmlSerializerSession getSession() {
return createSession().build();
}
//-----------------------------------------------------------------------------------------------------------------
// Extended metadata
//-----------------------------------------------------------------------------------------------------------------
@Override /* XmlMetaProvider */
public XmlClassMeta getXmlClassMeta(ClassMeta cm) {
XmlClassMeta m = xmlClassMetas.get(cm);
if (m == null) {
m = new XmlClassMeta(cm, this);
xmlClassMetas.put(cm, m);
}
return m;
}
@Override /* XmlMetaProvider */
public XmlBeanMeta getXmlBeanMeta(BeanMeta bm) {
XmlBeanMeta m = xmlBeanMetas.get(bm);
if (m == null) {
m = new XmlBeanMeta(bm, this);
xmlBeanMetas.put(bm, m);
}
return m;
}
@Override /* XmlMetaProvider */
public XmlBeanPropertyMeta getXmlBeanPropertyMeta(BeanPropertyMeta bpm) {
XmlBeanPropertyMeta m = xmlBeanPropertyMetas.get(bpm);
if (m == null) {
m = new XmlBeanPropertyMeta(bpm.getDelegateFor(), this);
xmlBeanPropertyMetas.put(bpm, m);
}
return m;
}
//-----------------------------------------------------------------------------------------------------------------
// Properties
//-----------------------------------------------------------------------------------------------------------------
/**
* Add "_type" properties when needed.
*
* @see Builder#addBeanTypesXml()
* @return
* true if"_type" properties will be added to beans if their type cannot be inferred
* through reflection.
*/
@Override
protected boolean isAddBeanTypes() {
return addBeanTypes;
}
/**
* Add namespace URLs to the root element.
*
* @see Builder#addNamespaceUrisToRoot()
* @return
* true if {@code xmlns:x} attributes are added to the root element for the default and all mapped namespaces.
*/
protected final boolean isAddNamespaceUrlsToRoot() {
return addNamespaceUrlsToRoot;
}
/**
* Auto-detect namespace usage.
*
* @see Builder#disableAutoDetectNamespaces()
* @return
* true if namespace usage is detected before serialization.
*/
protected final boolean isAutoDetectNamespaces() {
return autoDetectNamespaces;
}
/**
* Default namespace.
*
* @see Builder#defaultNamespace(Namespace)
* @return
* The default namespace URI for this document.
*/
protected final Namespace getDefaultNamespace() {
return defaultNamespace;
}
/**
* Enable support for XML namespaces.
*
* @see Builder#enableNamespaces()
* @return
* false if XML output will not contain any namespaces regardless of any other settings.
*/
protected final boolean isEnableNamespaces() {
return enableNamespaces;
}
/**
* Default namespaces.
*
* @see Builder#namespaces(Namespace...)
* @return
* The default list of namespaces associated with this serializer.
*/
protected final Namespace[] getNamespaces() {
return namespaces;
}
//-----------------------------------------------------------------------------------------------------------------
// Other methods
//-----------------------------------------------------------------------------------------------------------------
@Override /* Context */
protected JsonMap properties() {
return filteredMap()
.append("autoDetectNamespaces", autoDetectNamespaces)
.append("enableNamespaces", enableNamespaces)
.append("addNamespaceUrlsToRoot", addNamespaceUrlsToRoot)
.append("defaultNamespace", defaultNamespace)
.append("namespaces", namespaces)
.append("addBeanTypes", addBeanTypes);
}
}