joptsimple.OptionException Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jopt-simple Show documentation
A Java library for parsing command line options
There is a newer version: 6.0-alpha-3
/*
 The MIT License

 Copyright (c) 2004-2014 Paul R. Holser, Jr.

 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including
 without limitation the rights to use, copy, modify, merge, publish,
 distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:

 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

package joptsimple;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;

import static java.util.Collections.*;

import static joptsimple.internal.Strings.*;

/**
 * Thrown when a problem occurs during option parsing.
 *
 * @author Paul Holser
 */
public abstract class OptionException extends RuntimeException {
    private static final long serialVersionUID = -1L;

    private final List options = new ArrayList();

    protected OptionException( Collection options ) {
        this.options.addAll( options );
    }

    protected OptionException( Collection options, Throwable cause ) {
        super( cause );

        this.options.addAll( options );
    }

    /**
     * Gives the option being considered when the exception was created.
     *
     * @return the option being considered when the exception was created
     */
    public Collection options() {
        return unmodifiableCollection( options );
    }

    protected final String singleOptionMessage() {
        return singleOptionMessage( options.get( 0 ) );
    }

    protected final String singleOptionMessage( String option ) {
        return SINGLE_QUOTE + option + SINGLE_QUOTE;
    }

    protected final String multipleOptionMessage() {
        StringBuilder buffer = new StringBuilder( "[" );

        for ( Iterator iter = options.iterator(); iter.hasNext(); ) {
            buffer.append( singleOptionMessage( iter.next() ) );
            if ( iter.hasNext() )
                buffer.append( ", " );
        }

        buffer.append( ']' );

        return buffer.toString();
    }

    static OptionException unrecognizedOption( String option ) {
        return new UnrecognizedOptionException( option );
    }
}