de.weltraumschaf.commons.shell.CommandVerifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commons Show documentation

Common Utility Classes for Java.

There is a newer version: 0.4.0

/*
 * LICENSE
 *
 * "THE BEER-WARE LICENSE" (Revision 43):
 * "Sven Strittmatter"  wrote this file.
 * As long as you retain this notice you can do whatever you want with
 * this stuff. If we meet some day, and you think this stuff is worth it,
 * you can buy me a non alcohol-free beer in return.
 *
 * Copyright (C) 2012 "Sven Strittmatter" 
 */
package de.weltraumschaf.commons.shell;

/**
 * Implementors verifies the passed command.
 *
 * Verification means:
 * - Check if a main command has a legal sub command.
 * - Check if a command has legal arguments.
 *
 * If a check fails throw {@link SyntaxException}.
 *
 * @author Sven Strittmatter 
 */
public interface CommandVerifier {

    /**
     * Verifies parsed command of consistency.
     *
     * Consistency checks are:
     * - correct sub command type
     * - correct number of arguments
     *
     * @param cmd command to verify
     * @throws SyntaxException if, verification has failed
     */
    void verifyCommand(final ShellCommand cmd) throws SyntaxException;

}