| // *************************************************************************************************************************** | |
| // * 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 java.util.*; | |
| import java.util.concurrent.*; | |
| import org.apache.juneau.*; | |
| import org.apache.juneau.annotation.*; | |
| import org.apache.juneau.json.*; | |
| import org.apache.juneau.serializer.*; | |
| import org.apache.juneau.xmlschema.XmlSchemaSerializer; | |
| /** | |
| * Serializes POJO models to XML. | |
| * | |
| * <h5 class='topic'>Media types</h5> | |
| * | |
| * Handles <c>Accept</c> types: <bc>text/xml</bc> | |
| * <p> | |
| * Produces <c>Content-Type</c> types: <bc>text/xml</bc> | |
| * | |
| * <h5 class='topic'>Description</h5> | |
| * | |
| * See the {@link JsonSerializer} class for details on how Java models map to JSON. | |
| * | |
| * <p> | |
| * For example, the following JSON... | |
| * <p class='bcode w800'> | |
| * { | |
| * name:<js>'John Smith'</js>, | |
| * address: { | |
| * streetAddress: <js>'21 2nd Street'</js>, | |
| * city: <js>'New York'</js>, | |
| * state: <js>'NY'</js>, | |
| * postalCode: <js>10021</js> | |
| * }, | |
| * phoneNumbers: [ | |
| * <js>'212 555-1111'</js>, | |
| * <js>'212 555-2222'</js> | |
| * ], | |
| * additionalInfo: <jk>null</jk>, | |
| * remote: <jk>false</jk>, | |
| * height: <js>62.4</js>, | |
| * <js>'fico score'</js>: <js>' > 640'</js> | |
| * } | |
| * <p> | |
| * ...maps to the following XML using the default serializer... | |
| * <p class='bcode w800'> | |
| * <xt><object></xt> | |
| * <xt><name></xt>John Smith<xt></name></xt> | |
| * <xt><address></xt> | |
| * <xt><streetAddress></xt>21 2nd Street<xt></streetAddress></xt> | |
| * <xt><city></xt>New York<xt></city></xt> | |
| * <xt><state></xt>NY<xt></state></xt> | |
| * <xt><postalCode></xt>10021<xt></postalCode></xt> | |
| * <xt></address></xt> | |
| * <xt><phoneNumbers></xt> | |
| * <xt><string></xt>212 555-1111<xt></string></xt> | |
| * <xt><string></xt>212 555-2222<xt></string></xt> | |
| * <xt></phoneNumbers></xt> | |
| * <xt><additionalInfo</xt> <xa>_type</xa>=<xs>'null'</xs><xt>></additionalInfo></xt> | |
| * <xt><remote></xt>false<xt></remote></xt> | |
| * <xt><height></xt>62.4<xt></height></xt> | |
| * <xt><fico_x0020_score></xt> &gt; 640<xt></fico_x0020_score></xt> | |
| * <xt></object></xt> | |
| * | |
| * <p> | |
| * An additional "add-json-properties" mode is also provided to prevent loss of JSON data types... | |
| * <p class='bcode w800'> | |
| * <xt><name</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt>John Smith<xt></name></xt> | |
| * <xt><address</xt> <xa>_type</xa>=<xs>'object'</xs><xt>></xt> | |
| * <xt><streetAddress</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt>21 2nd Street<xt></streetAddress></xt> | |
| * <xt><city</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt>New York<xt></city></xt> | |
| * <xt><state</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt>NY<xt></state></xt> | |
| * <xt><postalCode</xt> <xa>_type</xa>=<xs>'number'</xs><xt>></xt>10021<xt></postalCode></xt> | |
| * <xt></address></xt> | |
| * <xt><phoneNumbers</xt> <xa>_type</xa>=<xs>'array'</xs><xt>></xt> | |
| * <xt><string></xt>212 555-1111<xt></string></xt> | |
| * <xt><string></xt>212 555-2222<xt></string></xt> | |
| * <xt></phoneNumbers></xt> | |
| * <xt><additionalInfo</xt> <xa>_type</xa>=<xs>'null'</xs><xt>></additionalInfo></xt> | |
| * <xt><remote</xt> <xa>_type</xa>=<xs>'boolean'</xs><xt>></xt>false<xt></remote></xt> | |
| * <xt><height</xt> <xa>_type</xa>=<xs>'number'</xs><xt>></xt>62.4<xt></height></xt> | |
| * <xt><fico_x0020_score</xt> <xa>_type</xa>=<xs>'string'</xs><xt>></xt> &gt; 640<xt></fico_x0020_score></xt> | |
| * <xt></object></xt> | |
| * </p> | |
| * | |
| * <p> | |
| * This serializer provides several serialization options. | |
| * Typically, one of the predefined <jsf>DEFAULT</jsf> serializers will be sufficient. | |
| * However, custom serializers can be constructed to fine-tune behavior. | |
| * | |
| * <p> | |
| * If an attribute name contains any non-valid XML element characters, they will be escaped using standard | |
| * {@code _x####_} notation. | |
| * | |
| * <h5 class='topic'>Behavior-specific subclasses</h5> | |
| * | |
| * The following direct subclasses are provided for convenience: | |
| * <ul> | |
| * <li>{@link Sq} - Default serializer, single quotes. | |
| * <li>{@link SqReadable} - Default serializer, single quotes, whitespace added. | |
| * </ul> | |
| */ | |
| @ConfigurableContext | |
| public class XmlSerializer extends WriterSerializer implements XmlMetaProvider, XmlCommon { | |
| //------------------------------------------------------------------------------------------------------------------- | |
| // Configurable properties | |
| //------------------------------------------------------------------------------------------------------------------- | |
| static final String PREFIX = "XmlSerializer"; | |
| /** | |
| * Configuration property: Add <js>"_type"</js> properties when needed. | |
| * | |
| * <h5 class='section'>Property:</h5> | |
| * <ul> | |
| * <li><b>Name:</b> <js>"XmlSerializer.addBeanTypes.b"</js> | |
| * <li><b>Data type:</b> <c>Boolean</c> | |
| * <li><b>Default:</b> <jk>false</jk> | |
| * <li><b>Session property:</b> <jk>false</jk> | |
| * <li><b>Methods:</b> | |
| * <ul> | |
| * <li class='jm'>{@link XmlSerializerBuilder#addBeanTypes(boolean)} | |
| * </ul> | |
| * </ul> | |
| * | |
| * <h5 class='section'>Description:</h5> | |
| * <p> | |
| * If <jk>true</jk>, then <js>"_type"</js> properties will be added to beans if their type cannot be inferred | |
| * through reflection. | |
| * | |
| * <p> | |
| * When present, this value overrides the {@link #SERIALIZER_addBeanTypes} setting and is | |
| * provided to customize the behavior of specific serializers in a {@link SerializerGroup}. | |
| */ | |
| public static final String XML_addBeanTypes = PREFIX + ".addBeanTypes.b"; | |
| /** | |
| * Configuration property: Add namespace URLs to the root element. | |
| * | |
| * <h5 class='section'>Property:</h5> | |
| * <ul> | |
| * <li><b>Name:</b> <js>"XmlSerializer.addNamespaceUrisToRoot.b"</js> | |
| * <li><b>Data type:</b> <c>Boolean</c> | |
| * <li><b>Default:</b> <jk>false</jk> | |
| * <li><b>Session property:</b> <jk>false</jk> | |
| * <li><b>Methods:</b> | |
| * <ul> | |
| * <li class='jm'>{@link XmlSerializerBuilder#addNamespaceUrisToRoot(boolean)} | |
| * <li class='jm'>{@link XmlSerializerBuilder#addNamespaceUrisToRoot()} | |
| * </ul> | |
| * </ul> | |
| * | |
| * <h5 class='section'>Description:</h5> | |
| * <p> | |
| * Use this setting to add {@code xmlns:x} attributes to the root element for the default and all mapped namespaces. | |
| * | |
| * <p> | |
| * This setting is ignored if {@link #XML_enableNamespaces} is not enabled. | |
| * | |
| * <ul class='seealso'> | |
| * <li class='link'>{@doc juneau-marshall.XmlDetails.Namespaces} | |
| * </ul> | |
| */ | |
| public static final String XML_addNamespaceUrisToRoot = PREFIX + ".addNamespaceUrisToRoot.b"; | |
| /** | |
| * Configuration property: Auto-detect namespace usage. | |
| * | |
| * <h5 class='section'>Property:</h5> | |
| * <ul> | |
| * <li><b>Name:</b> <js>"XmlSerializer.autoDetectNamespaces.b"</js> | |
| * <li><b>Data type:</b> <c>Boolean</c> | |
| * <li><b>Default:</b> <jk>true</jk> | |
| * <li><b>Session property:</b> <jk>false</jk> | |
| * <li><b>Methods:</b> | |
| * <ul> | |
| * <li class='jm'>{@link XmlSerializerBuilder#autoDetectNamespaces(boolean)} | |
| * </ul> | |
| * </ul> | |
| * | |
| * <h5 class='section'>Description:</h5> | |
| * <p> | |
| * Detect namespace usage before serialization. | |
| * | |
| * <p> | |
| * Used in conjunction with {@link #XML_addNamespaceUrisToRoot} to reduce the list of namespace URLs appended to the | |
| * root element to only those that will be used in the resulting document. | |
| * | |
| * <p> | |
| * If enabled, then the data structure will first be crawled looking for namespaces that will be encountered before | |
| * the root element is serialized. | |
| * | |
| * <p> | |
| * This setting is ignored if {@link #XML_enableNamespaces} is not enabled. | |
| * | |
| * <ul class='notes'> | |
| * <li> | |
| * Auto-detection of namespaces can be costly performance-wise. | |
| * <br>In high-performance environments, it's recommended that namespace detection be | |
| * disabled, and that namespaces be manually defined through the {@link #XML_namespaces} property. | |
| * </ul> | |
| * | |
| * <ul class='seealso'> | |
| * <li class='link'>{@doc juneau-marshall.XmlDetails.Namespaces} | |
| * </ul> | |
| */ | |
| public static final String XML_autoDetectNamespaces = PREFIX + ".autoDetectNamespaces.b"; | |
| /** | |
| * Configuration property: Default namespace. | |
| * | |
| * <h5 class='section'>Property:</h5> | |
| * <ul> | |
| * <li><b>Name:</b> <js>"XmlSerializer.defaultNamespace.s"</js> | |
| * <li><b>Data type:</b> <c>String</c> ({@link Namespace}) | |
| * <li><b>Default:</b> <js>"juneau: http://www.apache.org/2013/Juneau"</js> | |
| * <li><b>Session property:</b> <jk>false</jk> | |
| * <li><b>Methods:</b> | |
| * <ul> | |
| * <li class='jm'>{@link XmlSerializerBuilder#defaultNamespace(String)} | |
| * </ul> | |
| * </ul> | |
| * | |
| * <h5 class='section'>Description:</h5> | |
| * <p> | |
| * Specifies the default namespace URI for this document. | |
| * | |
| * <ul class='seealso'> | |
| * <li class='link'>{@doc juneau-marshall.XmlDetails.Namespaces} | |
| * </ul> | |
| */ | |
| public static final String XML_defaultNamespace = PREFIX + ".defaultNamespace.s"; | |
| /** | |
| * Configuration property: Enable support for XML namespaces. | |
| * | |
| * <h5 class='section'>Property:</h5> | |
| * <ul> | |
| * <li><b>Name:</b> <js>"XmlSerializer.enableNamespaces.b"</js> | |
| * <li><b>Data type:</b> <c>Boolean</c> | |
| * <li><b>Default:</b> <jk>false</jk> | |
| * <li><b>Session property:</b> <jk>false</jk> | |
| * <li><b>Methods:</b> | |
| * <ul> | |
| * <li class='jm'>{@link XmlSerializerBuilder#enableNamespaces(boolean)} | |
| * </ul> | |
| * </ul> | |
| * | |
| * <h5 class='section'>Description:</h5> | |
| * <p> | |
| * If not enabled, XML output will not contain any namespaces regardless of any other settings. | |
| * | |
| * <ul class='seealso'> | |
| * <li class='link'>{@doc juneau-marshall.XmlDetails.Namespaces} | |
| * </ul> | |
| */ | |
| public static final String XML_enableNamespaces = PREFIX + ".enableNamespaces.b"; | |
| /** | |
| * Configuration property: Default namespaces. | |
| * | |
| * <h5 class='section'>Property:</h5> | |
| * <ul> | |
| * <li><b>Name:</b> <js>"XmlSerializer.namespaces.ls"</js> | |
| * <li><b>Data type:</b> <c>Set<String></c> ({@link Namespace}) | |
| * <li><b>Default:</b> empty set | |
| * <li><b>Session property:</b> <jk>false</jk> | |
| * <li><b>Methods:</b> | |
| * <ul> | |
| * <li class='jm'>{@link XmlSerializerBuilder#defaultNamespace(String)} | |
| * </ul> | |
| * </ul> | |
| * | |
| * <h5 class='section'>Description:</h5> | |
| * <p> | |
| * The default list of namespaces associated with this serializer. | |
| * | |
| * <ul class='seealso'> | |
| * <li class='link'>{@doc juneau-marshall.XmlDetails.Namespaces} | |
| * </ul> | |
| */ | |
| public static final String XML_namespaces = PREFIX + ".namespaces.ls"; | |
| /** | |
| * Configuration property: XMLSchema namespace. | |
| * | |
| * <h5 class='section'>Property:</h5> | |
| * <ul> | |
| * <li><b>Name:</b> <js>"XmlSerializer.xsNamespace.s"</js> | |
| * <li><b>Data type:</b> <c>String</c> ({@link Namespace}) | |
| * <li><b>Default:</b> <js>"xs: http://www.w3.org/2001/XMLSchema"</js> | |
| * <li><b>Session property:</b> <jk>false</jk> | |
| * <li><b>Methods:</b> | |
| * <ul> | |
| * <li class='jm'>{@link XmlSerializerBuilder#xsNamespace(Namespace)} | |
| * </ul> | |
| * </ul> | |
| * | |
| * <h5 class='section'>Description:</h5> | |
| * <p> | |
| * Specifies the namespace for the <c>XMLSchema</c> namespace, used by the schema generated by the | |
| * {@link XmlSchemaSerializer} class. | |
| * | |
| * <ul class='seealso'> | |
| * <li class='link'>{@doc juneau-marshall.XmlDetails.Namespaces} | |
| * </ul> | |
| */ | |
| public static final String XML_xsNamespace = PREFIX + ".xsNamespace.s"; | |
| //------------------------------------------------------------------------------------------------------------------- | |
| // Predefined instances | |
| //------------------------------------------------------------------------------------------------------------------- | |
| /** Default serializer without namespaces. */ | |
| public static final XmlSerializer DEFAULT = new XmlSerializer(PropertyStore.DEFAULT); | |
| /** Default serializer without namespaces, with single quotes. */ | |
| public static final XmlSerializer DEFAULT_SQ = new Sq(PropertyStore.DEFAULT); | |
| /** Default serializer without namespaces, with single quotes, whitespace added. */ | |
| public static final XmlSerializer DEFAULT_SQ_READABLE = new SqReadable(PropertyStore.DEFAULT); | |
| /** Default serializer, all default settings. */ | |
| public static final XmlSerializer DEFAULT_NS = new Ns(PropertyStore.DEFAULT); | |
| /** Default serializer, single quotes. */ | |
| public static final XmlSerializer DEFAULT_NS_SQ = new NsSq(PropertyStore.DEFAULT); | |
| /** Default serializer, single quotes, whitespace added. */ | |
| public static final XmlSerializer DEFAULT_NS_SQ_READABLE = new NsSqReadable(PropertyStore.DEFAULT); | |
| //------------------------------------------------------------------------------------------------------------------- | |
| // Predefined subclasses | |
| //------------------------------------------------------------------------------------------------------------------- | |
| /** Default serializer, single quotes. */ | |
| public static class Sq extends XmlSerializer { | |
| /** | |
| * Constructor. | |
| * | |
| * @param ps The property store containing all the settings for this object. | |
| */ | |
| public Sq(PropertyStore ps) { | |
| super( | |
| ps.builder() | |
| .set(WSERIALIZER_quoteChar, '\'') | |
| .build() | |
| ); | |
| } | |
| } | |
| /** Default serializer, single quotes, whitespace added. */ | |
| public static class SqReadable extends XmlSerializer { | |
| /** | |
| * Constructor. | |
| * | |
| * @param ps The property store containing all the settings for this object. | |
| */ | |
| public SqReadable(PropertyStore ps) { | |
| super( | |
| ps.builder() | |
| .set(WSERIALIZER_quoteChar, '\'') | |
| .set(WSERIALIZER_useWhitespace, true) | |
| .build() | |
| ); | |
| } | |
| } | |
| /** Default serializer without namespaces. */ | |
| public static class Ns extends XmlSerializer { | |
| /** | |
| * Constructor. | |
| * | |
| * @param ps The property store containing all the settings for this object. | |
| */ | |
| public Ns(PropertyStore ps) { | |
| super( | |
| ps.builder() | |
| .set(XML_enableNamespaces, true) | |
| .build(), | |
| "text/xml", | |
| "text/xml+simple" | |
| ); | |
| } | |
| } | |
| /** Default serializer without namespaces, single quotes. */ | |
| public static class NsSq extends XmlSerializer { | |
| /** | |
| * Constructor. | |
| * | |
| * @param ps The property store containing all the settings for this object. | |
| */ | |
| public NsSq(PropertyStore ps) { | |
| super( | |
| ps.builder() | |
| .set(XML_enableNamespaces, true) | |
| .set(WSERIALIZER_quoteChar, '\'') | |
| .build() | |
| ); | |
| } | |
| } | |
| /** Default serializer without namespaces, single quotes, with whitespace. */ | |
| public static class NsSqReadable extends XmlSerializer { | |
| /** | |
| * Constructor. | |
| * | |
| * @param ps The property store containing all the settings for this object. | |
| */ | |
| public NsSqReadable(PropertyStore ps) { | |
| super( | |
| ps.builder() | |
| .set(XML_enableNamespaces, true) | |
| .set(WSERIALIZER_quoteChar, '\'') | |
| .set(WSERIALIZER_useWhitespace, true) | |
| .build() | |
| ); | |
| } | |
| } | |
| @SuppressWarnings("javadoc") | |
| protected static final Namespace | |
| DEFAULT_JUNEAU_NAMESPACE = Namespace.create("juneau", "http://www.apache.org/2013/Juneau"), | |
| DEFAULT_XS_NAMESPACE = Namespace.create("xs", "http://www.w3.org/2001/XMLSchema"); | |
| //------------------------------------------------------------------------------------------------------------------- | |
| // Instance | |
| //------------------------------------------------------------------------------------------------------------------- | |
| private final boolean | |
| autoDetectNamespaces, | |
| enableNamespaces, | |
| addNamespaceUrlsToRoot, | |
| addBeanTypes; | |
| private final Namespace defaultNamespace; | |
| private final Namespace | |
| xsNamespace; | |
| private final Namespace[] namespaces; | |
| private final Map<ClassMeta<?>,XmlClassMeta> xmlClassMetas = new ConcurrentHashMap<>(); | |
| private final Map<BeanMeta<?>,XmlBeanMeta> xmlBeanMetas = new ConcurrentHashMap<>(); | |
| private final Map<BeanPropertyMeta,XmlBeanPropertyMeta> xmlBeanPropertyMetas = new ConcurrentHashMap<>(); | |
| private volatile XmlSchemaSerializer schemaSerializer; | |
| /** | |
| * Constructor. | |
| * | |
| * @param ps | |
| * The property store containing all the settings for this object. | |
| */ | |
| public XmlSerializer(PropertyStore ps) { | |
| this(ps, "text/xml", (String)null); | |
| } | |
| /** | |
| * Constructor. | |
| * | |
| * @param ps | |
| * The property store containing all the settings for this object. | |
| * @param produces | |
| * The media type that this serializer produces. | |
| * @param accept | |
| * The accept media types that the serializer can handle. | |
| * <p> | |
| * Can contain meta-characters per the <c>media-type</c> specification of {@doc RFC2616.section14.1} | |
| * <p> | |
| * If empty, then assumes the only media type supported is <c>produces</c>. | |
| * <p> | |
| * For example, if this serializer produces <js>"application/json"</js> but should handle media types of | |
| * <js>"application/json"</js> and <js>"text/json"</js>, then the arguments should be: | |
| * <p class='bcode w800'> | |
| * <jk>super</jk>(ps, <js>"application/json"</js>, <js>"application/json,text/json"</js>); | |
| * </p> | |
| * <br>...or... | |
| * <p class='bcode w800'> | |
| * <jk>super</jk>(ps, <js>"application/json"</js>, <js>"*​/json"</js>); | |
| * </p> | |
| * <p> | |
| * The accept value can also contain q-values. | |
| */ | |
| public XmlSerializer(PropertyStore ps, String produces, String accept) { | |
| super(ps, produces, accept); | |
| autoDetectNamespaces = getBooleanProperty(XML_autoDetectNamespaces, true); | |
| enableNamespaces = getBooleanProperty(XML_enableNamespaces, false); | |
| addNamespaceUrlsToRoot = getBooleanProperty(XML_addNamespaceUrisToRoot, false); | |
| defaultNamespace = getInstanceProperty(XML_defaultNamespace, Namespace.class, DEFAULT_JUNEAU_NAMESPACE); | |
| addBeanTypes = getBooleanProperty(XML_addBeanTypes, getBooleanProperty(SERIALIZER_addBeanTypes, false)); | |
| xsNamespace = getInstanceProperty(XML_xsNamespace, Namespace.class, DEFAULT_XS_NAMESPACE); | |
| namespaces = getInstanceArrayProperty(XML_namespaces, Namespace.class, new Namespace[0]); | |
| } | |
| @Override /* Context */ | |
| public XmlSerializerBuilder builder() { | |
| return new XmlSerializerBuilder(getPropertyStore()); | |
| } | |
| /** | |
| * Instantiates a new clean-slate {@link XmlSerializerBuilder} object. | |
| * | |
| * <p> | |
| * This is equivalent to simply calling <code><jk>new</jk> XmlSerializerBuilder()</code>. | |
| * | |
| * <p> | |
| * Note that this method creates a builder initialized to all default settings, whereas {@link #builder()} copies | |
| * the settings of the object called on. | |
| * | |
| * @return A new {@link XmlSerializerBuilder} object. | |
| */ | |
| public static XmlSerializerBuilder create() { | |
| return new XmlSerializerBuilder(); | |
| } | |
| /** | |
| * Returns the schema serializer based on the settings of this serializer. | |
| * @return The schema serializer. | |
| */ | |
| public XmlSerializer getSchemaSerializer() { | |
| if (schemaSerializer == null) | |
| schemaSerializer = builder().build(XmlSchemaSerializer.class); | |
| return schemaSerializer; | |
| } | |
| @Override /* Serializer */ | |
| public XmlSerializerSession createSession() { | |
| return createSession(createDefaultSessionArgs()); | |
| } | |
| @Override /* Serializer */ | |
| public XmlSerializerSession createSession(SerializerSessionArgs args) { | |
| return new XmlSerializerSession(this, args); | |
| } | |
| //----------------------------------------------------------------------------------------------------------------- | |
| // 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 | |
| //----------------------------------------------------------------------------------------------------------------- | |
| /** | |
| * Configuration property: Add <js>"_type"</js> properties when needed. | |
| * | |
| * @see #XML_addBeanTypes | |
| * @return | |
| * <jk>true</jk> if<js>"_type"</js> properties will be added to beans if their type cannot be inferred | |
| * through reflection. | |
| */ | |
| @Override | |
| protected boolean isAddBeanTypes() { | |
| return addBeanTypes; | |
| } | |
| /** | |
| * Configuration property: Add namespace URLs to the root element. | |
| * | |
| * @see #XML_addNamespaceUrisToRoot | |
| * @return | |
| * <jk>true</jk> if {@code xmlns:x} attributes are added to the root element for the default and all mapped namespaces. | |
| */ | |
| protected final boolean isAddNamespaceUrlsToRoot() { | |
| return addNamespaceUrlsToRoot; | |
| } | |
| /** | |
| * Configuration property: Auto-detect namespace usage. | |
| * | |
| * @see #XML_autoDetectNamespaces | |
| * @return | |
| * <jk>true</jk> if namespace usage is detected before serialization. | |
| */ | |
| protected final boolean isAutoDetectNamespaces() { | |
| return autoDetectNamespaces; | |
| } | |
| /** | |
| * Configuration property: Default namespace. | |
| * | |
| * @see #XML_defaultNamespace | |
| * @return | |
| * The default namespace URI for this document. | |
| */ | |
| protected final Namespace getDefaultNamespace() { | |
| return defaultNamespace; | |
| } | |
| /** | |
| * Configuration property: Enable support for XML namespaces. | |
| * | |
| * @see #XML_enableNamespaces | |
| * @return | |
| * <jk>false</jk> if XML output will not contain any namespaces regardless of any other settings. | |
| */ | |
| protected final boolean isEnableNamespaces() { | |
| return enableNamespaces; | |
| } | |
| /** | |
| * Configuration property: Default namespaces. | |
| * | |
| * @see #XML_namespaces | |
| * @return | |
| * The default list of namespaces associated with this serializer. | |
| */ | |
| protected final Namespace[] getNamespaces() { | |
| return namespaces; | |
| } | |
| /** | |
| * Configuration property: XMLSchema namespace. | |
| * | |
| * @see #XML_xsNamespace | |
| * @return | |
| * The namespace for the <c>XMLSchema</c> namespace, used by the schema generated by the | |
| * {@link XmlSchemaSerializer} class. | |
| */ | |
| protected final Namespace getXsNamespace() { | |
| return xsNamespace; | |
| } | |
| //----------------------------------------------------------------------------------------------------------------- | |
| // Other methods | |
| //----------------------------------------------------------------------------------------------------------------- | |
| @Override /* Context */ | |
| public ObjectMap toMap() { | |
| return super.toMap() | |
| .append("XmlSerializer", new DefaultFilteringObjectMap() | |
| .append("autoDetectNamespaces", autoDetectNamespaces) | |
| .append("enableNamespaces", enableNamespaces) | |
| .append("addNamespaceUrlsToRoot", addNamespaceUrlsToRoot) | |
| .append("defaultNamespace", defaultNamespace) | |
| .append("xsNamespace", xsNamespace) | |
| .append("namespaces", namespaces) | |
| .append("addBeanTypes", addBeanTypes) | |
| ); | |
| } | |
| } |