com.fasterxml.jackson.annotation

Annotation Type JsonRootName

@Target(value={ANNOTATION_TYPE,TYPE})
@Retention(value=RUNTIME)
public @interface JsonRootName

Annotation similar to 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, name used for serialization should be name specified here, and deserializer will expect the name as well.

As of 2.4, one missing feature is property "alwaysWrap", which is hoped to be added in 2.5, and would be used to force root name wrapping for individual types.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Root name to use if root-level wrapping is enabled.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
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.

Element Detail

value

public abstract 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.

namespace

public abstract 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

Default:

""