org.apache.juneau.xml.annotation.XmlFormat 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.annotation;
/**
* XML format to use when serializing a POJO.
*
* See Also:
* - XML Details
*
*/
public enum XmlFormat {
/**
* Normal formatting (default).
*
*
* On a bean class, implies {@link #ELEMENTS} meaning bean properties will be serialized as child elements by default.
*
*
* On a bean property, implies {@link #ELEMENT} meaning the bean property will be serialized as a child element.
*/
DEFAULT,
/**
* Render a bean property as an attribute instead of an element.
*
*
* Only applicable for bean properties, not bean classes.
*
*
* Can only be applied to properties (methods/fields) of class types that can be convertible to Strings .
*/
ATTR,
/**
* Render property as attributes instead of an element.
*
*
* On a bean class, implies bean properties will be serialized as attributes instead of child elements by default.
*
*
* On bean properties, implies that the bean property value itself should be serialized as attributes on the bean
* element.
* The bean property data type must be of class type Map<Object,Object> where both
* objects are convertible to Strings .
*/
ATTRS,
/**
* Render property as an element instead of an attribute.
*
*
* Only applicable for bean properties, not bean classes.
*
*
* Used to override the behavior of the {@link #ATTRS} format applied to the bean class.
*/
ELEMENT,
/**
* Render property value directly as the contents of the element.
*
*
* On a bean class, implies that bean properties will be serialized as child elements.
* Note that this is equivalent to {@link #DEFAULT}.
*
*
* Only applicable for objects of type array/Collection.
*
*
* On a bean property, implies that the bean property value itself should be serialized as child elements of the
* bean element.
*/
ELEMENTS,
/**
* Same as {@link #ELEMENTS} except primitive types (string/boolean/number/null for example) are not wrapped in elements.
*
*
* Only applicable for bean properties, not bean classes.
*
*
* Only applicable for objects of type array/Collection.
*
*
* Use of this format may cause data type loss during parsing if the types cannot be inferred through reflection.
*/
MIXED,
/**
* Same as {@link XmlFormat#MIXED}, but whitespace in text nodes are not trimmed during parsing.
*
*
* An example use is HTML5 <pre> where whitespace should not be discarded.
*/
MIXED_PWS,
/**
* Render property value as the text content of the element.
*
*
* Similar to {@link #MIXED} but value must be a single value, not a collection.
*
*
* Only applicable for bean properties, not bean classes.
*
*
* Use of this format may cause data type loss during parsing if the type cannot be inferred through reflection.
*/
TEXT,
/**
* Same as {@link XmlFormat#TEXT}, but whitespace in text node is not trimmed during parsing.
*/
TEXT_PWS,
/**
* Same as {@link #TEXT} except the content is expected to be fully-formed XML that will get serialized as-is.
*
*
* During parsing, this XML text will be re-serialized and set on the property.
*
*
* Only applicable for bean properties, not bean classes.
*
*
* Use of this format may cause data type loss during parsing if the type cannot be inferred through reflection.
*/
XMLTEXT,
/**
* Prevents collections and arrays from being enclosed in <array> elements.
*
*
* Can only be applied to properties (methods/fields) of type collection or array, or collection classes.
*/
COLLAPSED,
/**
* Identifies a void element.
*
*
* Only applicable for bean classes.
*
*
* Identifies an element that never contains content.
*
*
* The main difference in behavior is how non-void empty elements are handled in the HTML serializer.
* Void elements are serialized as collapsed nodes (e.g. "<br/>" ) whereas non-void empty elements are
* serialized with an end tag (e.g. "<p></p>").
*/
VOID;
/**
* Returns true if this format is one of those specified.
*
* @param formats The formats to match against.
* @return true if this format is one of those specified.
*/
public boolean isOneOf(XmlFormat...formats) {
for (XmlFormat format : formats)
if (format == this)
return true;
return false;
}
}