net.oneandone.neberus.annotation.ApiAllowedValues 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 java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Define the allowed values for a parameter. This will be used to replace placeholders in the example curl.
 */
@Target({ ElementType.PARAMETER, ElementType.FIELD, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiAllowedValues {

    /**
     * The exact allowed values for this parameter.
     *
     * @return the value
     */
    String[] value() default {};

    /**
     * Hint about the allowed values.
     *
     * @return the valueHint
     */
    String valueHint() default "";

    /**
     * Allow all values of the specified enum.
     *
     * @return the enumClass
     */
    Class enumValues() default Enum.class;

}