com.greenpepper.call.Annotate Maven / Gradle / Ivy

package com.greenpepper.call;

import com.greenpepper.Annotatable;
import com.greenpepper.Example;

/**
 * Annotate class.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public final class Annotate
{
    /**
     * right.
     *
     * @param annotatable a {@link com.greenpepper.Annotatable} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub right(final Annotatable annotatable)
    {
        return new AnnotateRight( annotatable );
    }

    /**
     * wrong.
     *
     * @param annotatable a {@link com.greenpepper.Annotatable} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub wrong(Annotatable annotatable)
    {
        return new AnnotateWrong( annotatable, false );
    }

    /**
     * wrongWithDetails.
     *
     * @param annotatable a {@link com.greenpepper.Annotatable} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub wrongWithDetails(Annotatable annotatable)
    {
        return new AnnotateWrong( annotatable, true );
    }

    /**
     * exception.
     *
     * @param annotatable a {@link com.greenpepper.Annotatable} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub exception(Annotatable annotatable)
    {
        return new AnnotateException( annotatable );
    }

    private Annotate()
    {
    }

    /**
     * withDetails.
     *
     * @param annotatable a {@link com.greenpepper.Annotatable} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub withDetails(Annotatable annotatable)
    {
        return new AnnotateExample( annotatable, true );
    }

    /**
     * withoutDetail.
     *
     * @param annotatable a {@link com.greenpepper.Annotatable} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub withoutDetail(Annotatable annotatable)
    {
        return new AnnotateExample( annotatable, false );
    }

    /**
     * entered.
     *
     * @param annotatable a {@link com.greenpepper.Example} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub entered(Example annotatable)
    {
        return new AnnotateEntered( annotatable );
    }
    
    /**
     * notEntered.
     *
     * @param annotatable a {@link com.greenpepper.Example} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub notEntered(Example annotatable)
    {
        return new AnnotateNotEntered( annotatable );
    }

    /**
     * ignored.
     *
     * @param annotatable a {@link com.greenpepper.Annotatable} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub ignored(Annotatable annotatable)
    {
        return new AnnotateIgnored( annotatable );
    }
    
    /**
     * setup.
     *
     * @param annotatable a {@link com.greenpepper.Example} object.
     * @return a {@link com.greenpepper.call.Stub} object.
     */
    public static Stub setup(Example annotatable)
    {
        return new AnnotateSetup( annotatable );
    }
}