com.nhl.link.rest.annotation.LrResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of link-rest-annotations Show documentation

A dependency-free collection of LR annotations that allow to annotate model objects without introducing a dependency on LinkRest runtime.

There is a newer version: 2.13

Show newest version

package com.nhl.link.rest.annotation;

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

/**
 * Used to indicate that web method is an LR resource.
 *
 * @since 2.10
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LrResource {
    /**
     * @return Class of LR entity that this resource works with.
     */
    Class entityClass() default Object.class;

    /**
     * @return type of this resource. If not set then type is {@link LinkType#UNDEFINED}
     */
    LinkType type() default LinkType.UNDEFINED;
}