org.apache.juneau.json.annotation

Annotation Type Json

@Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
public @interface Json

Annotation for specifying various JSON options for the JSON serializers and parsers.

Can be applied to Java types.

Can be used for the following:

• Wrap bean instances inside wrapper object (e.g. {'wrapperAttr':bean}).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	wrapperAttr Wraps beans in a JSON object with the specified attribute name.

Element Detail

wrapperAttr

public abstract String wrapperAttr

Wraps beans in a JSON object with the specified attribute name.

Applies only to ElementType.TYPE.

This annotation can be applied to beans as well as other objects serialized to other types (e.g. strings).

Example:

@Json(wrapperAttr="myWrapper") public class MyBean { public int f1 = 123; }

Without the @Json annotations, serializing this bean as JSON would have produced the following...

{ f1: 123 }

With the annotations, serializing this bean as JSON produces the following...

{ myWrapper: { f1: 123 } }

Default:

""