jp.vmi.selenium.selenese.command.StartLoop Maven / Gradle / Ivy

package jp.vmi.selenium.selenese.command;

/**
 * Interface for beginning-of-loop commands.
 */
public interface StartLoop {

    /** Use NO_START_LOOP instaed of null. */
    public static final StartLoop NO_START_LOOP = new StartLoop() {

        @Override
        public void setEndLoop(EndLoop endLoop) {
            // no operation.
        }

        @Override
        public void resetReachedCount() {
            // no operation.
        }

        @Override
        public void incrementReachedCount() {
            // no operation.
        }

        @Override
        public String getReachedCounts() {
            return "";
        }
    };

    /** The separator of reached counts. */
    public static final String REACHED_COUNT_SEPARATOR = "-";

    /**
     * Set end-of-loop command.
     *
     * @param endLoop end-of-loop command.
     */
    void setEndLoop(EndLoop endLoop);

    /**
     * Reset reached count.
     */
    void resetReachedCount();

    /**
     * Increment reached count.
     */
    void incrementReachedCount();

    /**
     * Get nested reached counts separated by REACHED_COUNT_SEPARATOR.
     *
     * @return reached counts.
     */
    String getReachedCounts();
}