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-2015 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 56 package jdk.internal.joptsimple; 57 58 import java.util.ArrayList; 59 import java.util.Collection; 60 import java.util.Iterator; 61 import java.util.LinkedHashSet; 62 import java.util.List; 63 import java.util.Locale; 64 import java.util.Set; 65 66 import jdk.internal.joptsimple.internal.Strings; 67 68 import static java.util.Collections.*; 69 import static jdk.internal.joptsimple.internal.Messages.*; 70 71 /** 72 * Thrown when a problem occurs during option parsing. 73 * 74 * @author <a href="mailto:pholser@alumni.rice.edu">Paul Holser</a> 75 */ 76 public abstract class OptionException extends RuntimeException { 77 private static final long serialVersionUID = -1L; 78 79 private final List<String> options = new ArrayList<>(); 80 OptionException( List<String> options )81 protected OptionException( List<String> options ) { 82 this.options.addAll( options ); 83 } 84 OptionException( Collection<? extends OptionSpec<?>> options )85 protected OptionException( Collection<? extends OptionSpec<?>> options ) { 86 this.options.addAll( specsToStrings( options ) ); 87 } 88 OptionException( Collection<? extends OptionSpec<?>> options, Throwable cause )89 protected OptionException( Collection<? extends OptionSpec<?>> options, Throwable cause ) { 90 super( cause ); 91 this.options.addAll( specsToStrings( options ) ); 92 } 93 specsToStrings( Collection<? extends OptionSpec<?>> options )94 private List<String> specsToStrings( Collection<? extends OptionSpec<?>> options ) { 95 List<String> strings = new ArrayList<>(); 96 for ( OptionSpec<?> each : options ) 97 strings.add( specToString( each ) ); 98 return strings; 99 } 100 specToString( OptionSpec<?> option )101 private String specToString( OptionSpec<?> option ) { 102 return Strings.join( new ArrayList<>( option.options() ), "/" ); 103 } 104 105 /** 106 * Gives the option being considered when the exception was created. 107 * 108 * @return the option being considered when the exception was created 109 */ options()110 public List<String> options() { 111 return unmodifiableList( options ); 112 } 113 singleOptionString()114 protected final String singleOptionString() { 115 return singleOptionString( options.get( 0 ) ); 116 } 117 singleOptionString( String option )118 protected final String singleOptionString( String option ) { 119 return option; 120 } 121 multipleOptionString()122 protected final String multipleOptionString() { 123 StringBuilder buffer = new StringBuilder( "[" ); 124 125 Set<String> asSet = new LinkedHashSet<String>( options ); 126 for ( Iterator<String> iter = asSet.iterator(); iter.hasNext(); ) { 127 buffer.append( singleOptionString(iter.next()) ); 128 if ( iter.hasNext() ) 129 buffer.append( ", " ); 130 } 131 132 buffer.append( ']' ); 133 134 return buffer.toString(); 135 } 136 unrecognizedOption( String option )137 static OptionException unrecognizedOption( String option ) { 138 return new UnrecognizedOptionException( option ); 139 } 140 141 @Override getMessage()142 public final String getMessage() { 143 return localizedMessage( Locale.getDefault() ); 144 } 145 localizedMessage( Locale locale )146 final String localizedMessage( Locale locale ) { 147 return formattedMessage( locale ); 148 } 149 formattedMessage( Locale locale )150 private String formattedMessage( Locale locale ) { 151 return message( locale, "jdk.internal.joptsimple.ExceptionMessages", getClass(), "message", messageArguments() ); 152 } 153 messageArguments()154 abstract Object[] messageArguments(); 155 } 156