/*
 The MIT License

 Copyright (c) 2010-2021 Paul R. Holser, Jr.

 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including
 without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:

 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

package com.pholser.junit.quickcheck;

import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

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

/**
 * Mark a parameter of a {@link Property} method with this annotation to
 * specify metadata about values generated for that parameter.
 */
@Target(PARAMETER)
@Retention(RUNTIME)
public @interface When {
    /**
     * @return the ratio of discarded generated values to successful generated
     * values above which values for the annotated property parameter will
     * no longer be generated. For a non-positive value, an
     * {@link IllegalArgumentException} is raised. The default value is 10,
     * to curtail generation for {@link #satisfies()} expressions that are
     * difficult to satisfy or can never be satisfied (inadvertently or
     * otherwise).
     */
    int discardRatio() default 10;

    /**
     * @return an <a href="http://commons.apache.org/ognl/">OGNL</a> expression
     * used to constrain the values fed to the annotated property parameter.
     * The expression should evaluate to a {@code boolean} value. Within the
     * expression, {@code "_"} refers to the property parameter.
     */
    String satisfies() default "";

    /**
     * @return a value to be used as the initial seed for the random value
     * generator. Not specifying a value causes the seed to be chosen
     * randomly.
     */
    long seed() default 0;
}
