com.github.restup.annotations.field

Annotation Type Relationship

@Target(value={FIELD,METHOD})
 @Retention(value=RUNTIME)
 @Documented
public @interface Relationship

Annotation which defines a relationship between resources

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
Class<?>	resource The resource class has a relationship to

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	includable If true, the resource may be included
String	joinField The field of resource() that the annotated field has a relationship to
String	name The name of the relationship.
RelationshipType	type By default, relationships are assumed to be "to many", setting to true will treat the relationships as 1:1
boolean	validateReferences If true, create and updates will validate references

Element Detail

resource

public abstract Class<?> resource

The resource class has a relationship to

name

public abstract String name

The name of the relationship. If left as the default value, the resource name will be used

Default:

""

joinField

public abstract String joinField

The field of resource() that the annotated field has a relationship to

Default:

"id"

validateReferences

public abstract boolean validateReferences

If true, create and updates will validate references

Default:

true

includable

public abstract boolean includable

If true, the resource may be included

Default:

true

type

public abstract RelationshipType type

By default, relationships are assumed to be "to many", setting to true will treat the relationships as 1:1

Default:

com.github.restup.annotations.field.RelationshipType.manyToOne