com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement Maven / Gradle / Ivy

Go to download
package com.fasterxml.jackson.dataformat.xml.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation that can be used to define name of root element used
 * for the root-level object when serialized, which normally uses
 * name of the type (class). It is similar to JAXB XmlRootElement
 * and basically an alias for standard Jackson annotation
 * {@link com.fasterxml.jackson.annotation.JsonRootName} (which you should
 * usually use instead).
 *
 * Note that annotation has no effect on non-root elements: regular property
 * values and so on; their name is derived from getter/setter/field, not
 * from type itself.
 *
 * NOTE! Since 2.4 this annotation is usually not necessary and you should use
 * {@link com.fasterxml.jackson.annotation.JsonRootName} instead.
 * About the only expected usage may be to have different root name for XML
 * content than other formats.
 */
@Target({ElementType.ANNOTATION_TYPE, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface JacksonXmlRootElement
{
    String namespace() default "";
    String localName() default "";
}