blob: 7f6fb7812f7333594d3d4056822fe7851fd3c75d [file] [log] [blame]
<!--
/***************************************************************************************************************************
* 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.
***************************************************************************************************************************/
-->
XML Serializers
<p>
The {@link oaj.xml.XmlSerializer} class is used to serialize POJOs into XML.
</p>
<p>
The {@link oaj.xml.XmlDocSerializer} class is the same, but serializes a <xt>&lt;?xml?&gt;</xt> header
at the top of the file.
</p>
<p>
The XML serializers provide the following settings:
</p>
<ul class='javatree'>
<li class='link'>{@doc juneau-marshall.ConfigurableProperties.Common Common Properties}
<li class='link'>{@doc juneau-marshall.ConfigurableProperties.CommonSerializer Common Serializer Properties}
<li class='jc'>{@link oaj.xml.XmlSerializer}
<ul>
<li class='jf'>{@link oaj.xml.XmlSerializer#XML_addBeanTypes XML_addBeanTypes}
<li class='jf'>{@link oaj.xml.XmlSerializer#XML_addNamespaceUrisToRoot XML_addNamespaceUrisToRoot}
<li class='jf'>{@link oaj.xml.XmlSerializer#XML_autoDetectNamespaces XML_autoDetectNamespaces}
<li class='jf'>{@link oaj.xml.XmlSerializer#XML_defaultNamespace XML_defaultNamespace}
<li class='jf'>{@link oaj.xml.XmlSerializer#XML_enableNamespaces XML_enableNamespaces}
<li class='jf'>{@link oaj.xml.XmlSerializer#XML_namespaces XML_namespaces}
<li class='jf'>{@link oaj.xml.XmlSerializer#XML_xsNamespace XML_xsNamespace}
</ul>
</ul>
<p>
The following pre-configured serializers are provided for convenience:
</p>
<ul class='javatree'>
<li class='jc'>{@link oaj.xml.XmlSerializer}
<ul>
<li class='jf'>{@link oaj.xml.XmlSerializer#DEFAULT DEFAULT}
<li class='jf'>{@link oaj.xml.XmlSerializer#DEFAULT_JUNEAU_NAMESPACE DEFAULT_JUNEAU_NAMESPACE}
<li class='jf'>{@link oaj.xml.XmlSerializer#DEFAULT_NS DEFAULT_NS}
<li class='jf'>{@link oaj.xml.XmlSerializer#DEFAULT_NS_SQ DEFAULT_NS_SQ}
<li class='jf'>{@link oaj.xml.XmlSerializer#DEFAULT_NS_SQ_READABLE DEFAULT_NS_SQ_READABLE}
<li class='jf'>{@link oaj.xml.XmlSerializer#DEFAULT_SQ DEFAULT_SQ}
<li class='jf'>{@link oaj.xml.XmlSerializer#DEFAULT_SQ_READABLE DEFAULT_SQ_READABLE}
<li class='jf'>{@link oaj.xml.XmlSerializer#DEFAULT_XS_NAMESPACE DEFAULT_XS_NAMESPACE}
</ul>
</ul>