org.jsondoc.core.annotation

Annotation Type ApiObjectField

@Documented
 @Target(value=FIELD)
 @Retention(value=RUNTIME)
public @interface ApiObjectField

This annotation is to be used on your objects' fields and represents a field of an object

Author:

Fabio Maffioletti

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	allowedvalues The allowed values for this field
String	description A drescription of what the field is
String	format The format pattern for this field
String	name The display name for this field if different from the java name
int	order Order of field in generated example.
boolean	processtemplate Whether to process the template for this object or not.
boolean	required If the field is required

Element Detail

description

public abstract String description

A drescription of what the field is

Returns:

Default:

""

format

public abstract String format

The format pattern for this field

Returns:

Default:

""

allowedvalues

public abstract String[] allowedvalues

The allowed values for this field

Returns:

Default:

{}

required

public abstract boolean required

If the field is required

Returns:

Default:

false

name

public abstract String name

The display name for this field if different from the java name

Returns:

Default:

""

order

public abstract int order

Order of field in generated example.

Returns:

Default:

2147483647

processtemplate

public abstract boolean processtemplate

Whether to process the template for this object or not. It's similar to what can be obtained using the JsonIdentityInfo/JsonManagedReference/JsonBackReference. Set this to true to avoid StackOverflow when your object has a circular or self dependency.

Returns:

Default:

true