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

package jp.vmi.selenium.selenese.command;

import jp.vmi.selenium.selenese.Context;
import jp.vmi.selenium.selenese.result.Result;

import static jp.vmi.selenium.selenese.command.ArgumentType.*;
import static jp.vmi.selenium.selenese.result.Success.*;

/**
 * 
 */
public class Comment extends AbstractCommand {

    private static final String COMMENT_PREFIX = "### ";

    private static final String COMMENT_SUFFIX = " ###";

    private static final int MESSAGE = 0;

    Comment(int index, String name, String... args) {
        super(-1, name, args, VALUE);
    }

    @Override
    public boolean mayUpdateScreen() {
        return false;
    }

    @Override
    protected Result executeImpl(Context context, String... curArgs) {
        return SUCCESS;
    }

    @Override
    public String toString() {
        return COMMENT_PREFIX + getArguments()[MESSAGE] + COMMENT_SUFFIX;
    }
}