io.katharsis.repository.annotations.JsonApiAddRelations Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of katharsis-core Show documentation

Core Katharsis library

There is a newer version: 3.0.2

package io.katharsis.repository.annotations;

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

/**
 * 
 * Method annotated with this annotation will be used to add relationship resources to a particular resource. The method
 * must be defined in a class annotated with {@link JsonApiRelationshipRepository}.
 * 
 * 
 * The requirements for the method parameters are as follows:
 * 
 * 
 *     Instance of a source resource
 *     {@link Iterable} of relationships to be add
 *     Relationship's filed name
 * 
 * 
 * The method's return value should be void.
 * 
 *
 * @see io.katharsis.repository.RelationshipRepository#addRelations(Object, Iterable, String)
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface JsonApiAddRelations {
}