net.jbock.util.ErrToken Maven / Gradle / Ivy

Go to download

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

jbock annotations and utils

The newest version!

package net.jbock.util;

import net.jbock.model.CommandModel;

/**
 * Represents some general error in the command line syntax.
 * The specific type of error is returned from the {@link #errorType()} method.
 */
public final class ErrToken extends ParsingFailed {

    private final ErrTokenType errorType;
    private final String token;

    /**
     * Public constructor.
     *
     * @param commandModel command model
     * @param errorType specific error type
     * @param token offending token
     */
    public ErrToken(CommandModel commandModel, ErrTokenType errorType, String token) {
        super(commandModel);
        this.errorType = errorType;
        this.token = token;
    }

    /**
     * Returns the specific type of this error.
     *
     * @return the error type
     */
    public ErrTokenType errorType() {
        return errorType;
    }

    /**
     * Returns the item related to this error.
     *
     * @return the item name
     */
    public String token() {
        return token;
    }

    @Override
    public String message() {
        switch (errorType) {
            case MISSING_ARGUMENT:
                return "Missing argument after option name: " + token;
            case INVALID_OPTION:
                return "Invalid option: " + token;
            case EXCESS_PARAM:
                return "Excess param: " + token;
            case OPTION_REPETITION:
                return String.format("Option '%s' is a repetition", token);
            case INVALID_UNIX_GROUP:
                return "Invalid token: " + token;
            default:
                throw new AssertionError("all cases exhausted");
        }
    }
}