Top Description Methods
com.fasterxml.jackson.annotation

public @Interface JsonRootName

extends Annotation
Annotations
@Target:ANNOTATION_TYPE, TYPE
@Retention:RUNTIME
@JacksonAnnotation
Imports
java.lang.annotation.ElementType, .Retention, .RetentionPolicy, .Target

Annotation similar to javax.xml.bind.annotation.XmlRootElement, used to indicate name to use for root-level wrapping, if wrapping is enabled. Annotation itself does not indicate that wrapping should be used; but if it is, the name used for serialization should be the name specified here, and deserializer will expect the name as well.

Method Summary

Modifier and TypeMethod and Description
public String
namespace()

Optional namespace to use with data formats that support such concept (specifically XML); if so, used with value to construct fully-qualified name.

public String
value()

Root name to use if root-level wrapping is enabled.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

namespaceback to summary
public String namespace()

Optional namespace to use with data formats that support such concept (specifically XML); if so, used with value to construct fully-qualified name.

Since
2.4
valueback to summary
public String value()

Root name to use if root-level wrapping is enabled. For data formats that use composite names (XML), this is the "local part" of the name to use.