OptionException.java revision 13547:2d461cd667ba 
1/*
2 * Copyright (c) 2009, 2015, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26/*
27 * This file is available under and governed by the GNU General Public
28 * License version 2 only, as published by the Free Software Foundation.
29 * However, the following notice accompanied the original version of this
30 * file:
31 *
32 * The MIT License
33 *
34 * Copyright (c) 2004-2014 Paul R. Holser, Jr.
35 *
36 * Permission is hereby granted, free of charge, to any person obtaining
37 * a copy of this software and associated documentation files (the
38 * "Software"), to deal in the Software without restriction, including
39 * without limitation the rights to use, copy, modify, merge, publish,
40 * distribute, sublicense, and/or sell copies of the Software, and to
41 * permit persons to whom the Software is furnished to do so, subject to
42 * the following conditions:
43 *
44 * The above copyright notice and this permission notice shall be
45 * included in all copies or substantial portions of the Software.
46 *
47 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
48 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
49 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
50 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
51 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
52 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
53 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
54 */
55
56package jdk.internal.joptsimple;
57
58import java.util.ArrayList;
59import java.util.Collection;
60import java.util.Iterator;
61import java.util.List;
62
63import static java.util.Collections.*;
64
65import static jdk.internal.joptsimple.internal.Strings.*;
66
67/**
68 * Thrown when a problem occurs during option parsing.
69 *
70 * @author <a href="mailto:pholser@alumni.rice.edu">Paul Holser</a>
71 */
72public abstract class OptionException extends RuntimeException {
73    private static final long serialVersionUID = -1L;
74
75    private final List<String> options = new ArrayList<String>();
76
77    protected OptionException( Collection<String> options ) {
78        this.options.addAll( options );
79    }
80
81    protected OptionException( Collection<String> options, Throwable cause ) {
82        super( cause );
83
84        this.options.addAll( options );
85    }
86
87    /**
88     * Gives the option being considered when the exception was created.
89     *
90     * @return the option being considered when the exception was created
91     */
92    public Collection<String> options() {
93        return unmodifiableCollection( options );
94    }
95
96    protected final String singleOptionMessage() {
97        return singleOptionMessage( options.get( 0 ) );
98    }
99
100    protected final String singleOptionMessage( String option ) {
101        return SINGLE_QUOTE + option + SINGLE_QUOTE;
102    }
103
104    protected final String multipleOptionMessage() {
105        StringBuilder buffer = new StringBuilder( "[" );
106
107        for ( Iterator<String> iter = options.iterator(); iter.hasNext(); ) {
108            buffer.append( singleOptionMessage( iter.next() ) );
109            if ( iter.hasNext() )
110                buffer.append( ", " );
111        }
112
113        buffer.append( ']' );
114
115        return buffer.toString();
116    }
117
118    static OptionException unrecognizedOption( String option ) {
119        return new UnrecognizedOptionException( option );
120    }
121}
122