com.greenpepper.util.cli.WrongOptionUsageException Maven / Gradle / Ivy

/*
 * Copyright (c) 2006 Pyxis Technologies inc.
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA,
 * or see the FSF site: http://www.fsf.org.
 */

package com.greenpepper.util.cli;

/**
 * WrongOptionUsageException class.
 *
 * @author oaouattara
 * @version $Id: $Id
 */
public class WrongOptionUsageException extends ParseException
{
    private final Option opt;

    /**
     * Constructor for WrongOptionUsageException.
     *
     * @param option a {@link com.greenpepper.util.cli.Option} object.
     */
    public WrongOptionUsageException( Option option )
    {
        this( option, null );
    }

    /**
     * Constructor for WrongOptionUsageException.
     *
     * @param option a {@link com.greenpepper.util.cli.Option} object.
     * @param cause a {@link java.lang.Throwable} object.
     */
    public WrongOptionUsageException( Option option, Throwable cause )
    {
        super( cause );
        this.opt = option;
    }

    /**
     * Getter for the field opt.
     *
     * @return a {@link com.greenpepper.util.cli.Option} object.
     */
    public Option getOpt()
    {
        return opt;
    }

    /**
     * getMessage.
     *
     * @return a {@link java.lang.String} object.
     */
    public String getMessage()
    {
        return "Wrong option usage: " + opt.toString();
    }
}