|
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 |
|
56 package jdk.internal.joptsimple; |
|
57 |
|
58 import java.util.Collection; |
|
59 import java.util.List; |
|
60 |
|
61 /** |
|
62 * Describes options that an option parser recognizes. |
|
63 * |
|
64 * <p>Instances of this interface are returned by the "fluent interface" methods to allow retrieval of option arguments |
|
65 * in a type-safe manner. Here's an example:</p> |
|
66 * |
|
67 * <pre><code> |
|
68 * OptionParser parser = new OptionParser(); |
|
69 * <strong>OptionSpec<Integer></strong> count = |
|
70 * parser.accepts( "count" ).withRequiredArg().ofType( Integer.class ); |
|
71 * OptionSet options = parser.parse( "--count", "2" ); |
|
72 * assert options.has( count ); |
|
73 * int countValue = options.valueOf( count ); |
|
74 * assert countValue == count.value( options ); |
|
75 * List<Integer> countValues = options.valuesOf( count ); |
|
76 * assert countValues.equals( count.values( options ) ); |
|
77 * </code></pre> |
|
78 * |
|
79 * @param <V> represents the type of the arguments this option accepts |
|
80 * @author <a href="mailto:pholser@alumni.rice.edu">Paul Holser</a> |
|
81 */ |
|
82 public interface OptionSpec<V> { |
|
83 /** |
|
84 * Gives any arguments associated with the given option in the given set of detected options. |
|
85 * |
|
86 * <p>Specifying a {@linkplain ArgumentAcceptingOptionSpec#defaultsTo(Object, Object[]) default argument value} |
|
87 * for this option will cause this method to return that default value even if this option was not detected on the |
|
88 * command line, or if this option can take an optional argument but did not have one on the command line.</p> |
|
89 * |
|
90 * @param detectedOptions the detected options to search in |
|
91 * @return the arguments associated with this option; an empty list if no such arguments are present, or if this |
|
92 * option was not detected |
|
93 * @throws OptionException if there is a problem converting this option's arguments to the desired type; for |
|
94 * example, if the type does not implement a correct conversion constructor or method |
|
95 * @throws NullPointerException if {@code detectedOptions} is {@code null} |
|
96 * @see OptionSet#valuesOf(OptionSpec) |
|
97 */ |
|
98 List<V> values( OptionSet detectedOptions ); |
|
99 |
|
100 /** |
|
101 * Gives the argument associated with the given option in the given set of detected options. |
|
102 * |
|
103 * <p>Specifying a {@linkplain ArgumentAcceptingOptionSpec#defaultsTo(Object, Object[]) default argument value} |
|
104 * for this option will cause this method to return that default value even if this option was not detected on the |
|
105 * command line, or if this option can take an optional argument but did not have one on the command line.</p> |
|
106 * |
|
107 * @param detectedOptions the detected options to search in |
|
108 * @return the argument of the this option; {@code null} if no argument is present, or that option was not detected |
|
109 * @throws OptionException if more than one argument was detected for the option |
|
110 * @throws NullPointerException if {@code detectedOptions} is {@code null} |
|
111 * @throws ClassCastException if the arguments of this option are not of the expected type |
|
112 * @see OptionSet#valueOf(OptionSpec) |
|
113 */ |
|
114 V value( OptionSet detectedOptions ); |
|
115 |
|
116 /** |
|
117 * @return the string representations of this option |
|
118 */ |
|
119 Collection<String> options(); |
|
120 |
|
121 /** |
|
122 * Tells whether this option is designated as a "help" option. The presence of a "help" option on a command line |
|
123 * means that missing "required" options will not cause parsing to fail. |
|
124 * |
|
125 * @return whether this option is designated as a "help" option |
|
126 */ |
|
127 boolean isForHelp(); |
|
128 } |