net.oneandone.neberus.annotation.ApiWarning Maven / Gradle / Ivy

Go to download

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

There is a newer version: 4.2.1

package net.oneandone.neberus.annotation;

import net.oneandone.neberus.model.ProblemType;

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

/**
 * A single Warning used in {@link ApiWarningResponse}.
 */
@Target({})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiWarning {

    ProblemType type();

    /**
     * The "title" displayed in the Warning. Will be ignored, if no {@link #type() } is set.
     *
     * @return the title
     */
    String title() default "";

    /**
     * The "detail" displayed in the Warning. Will be ignored, if no {@link #type() } is set.
     *
     * @return the detail
     */
    String detail() default "";

}