com.github.jasminb.jsonapi.annotations.RelationshipLinks Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsonapi-converter Show documentation

JSONAPI-Converter is a library that provides means for integrating with services using JSON API specification.

There is a newer version: 0.14

package com.github.jasminb.jsonapi.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Relationship links annotation.
 *
 * This annotation is used in conjunction with @Relationship annotation, attribute annotated with this annotation
 * is considered to be {@link com.github.jasminb.jsonapi.Links} related to named relationship object.
 *
 *  * 
 *     {@literal @}Type("my-type")
 *     public class MyType {
 *     	   {@literal @}Id
 *         private String id;
 *
 *         {@literal @}Relationship("relationship")
 *         private MyRelationship myRelationship;
 *
 *         {@literal @}RelationshipLinks("relationship")
 *         private com.github.jasminb.jsonapi.Links links;
 *
 *     }
 * 
 * 
 *
 * @author jbegic
 */
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface RelationshipLinks {
	String value();
}