io.katharsis.resource.annotations.JsonApiToOne 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.resource.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;

/**
 * Indicates an association to single value which need to be handled by a separate repository.
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.METHOD})
public @interface JsonApiToOne {

    /**
     * Defines whether the data associated to the relation should be visible when requesting information about a
     * resource that contains this relation.
     * @return true if lazy, false otherwise
     */
    boolean lazy() default false;
}