com.yahoo.elide.annotation

Annotation Type Include

@Target(value={TYPE,PACKAGE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface Include

Allows access to given entity.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	rootLevel (Optional) Whether or not the entity can be accessed at the root URL path (i.e.
String	type The type of the JsonApi object.

Element Detail

rootLevel

public abstract boolean rootLevel

(Optional) Whether or not the entity can be accessed at the root URL path (i.e. /company)

Returns:

the boolean

Default:

false

type

public abstract String type

The type of the JsonApi object. Defaults to the simple name of the entity class.

Returns:

the string

Default:

""