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, in ways that might be useful to {@linkplain HelpFormatter

    63  * help screens}.

    64  *

    65  * @author <a href="mailto:pholser@alumni.rice.edu">Paul Holser</a>

    66  */

    67 public interface OptionDescriptor {

    68     /**

    69      * A set of options that are mutually synonymous.

    70      *

    71      * @return synonymous options

    72      */

    73     Collection<String> options();

    74 

    75     /**

    76      * Description of this option's purpose.

    77      *

    78      * @return a description for the option

    79      */

    80     String description();

    81 

    82     /**

    83      * What values will the option take if none are specified on the command line?

    84      *

    85      * @return any default values for the option

    86      */

    87     List<?> defaultValues();

    88 

    89     /**

    90      * Is this option {@linkplain ArgumentAcceptingOptionSpec#required() required} on a command line?

    91      *

    92      * @return whether the option is required

    93      */

    94     boolean isRequired();

    95 

    96     /**

    97      * Does this option {@linkplain ArgumentAcceptingOptionSpec accept arguments}?

    98      *

    99      * @return whether the option accepts arguments

   100      */

   101     boolean acceptsArguments();

   102 

   103     /**

   104      * Does this option {@linkplain OptionSpecBuilder#withRequiredArg() require an argument}?

   105      *

   106      * @return whether the option requires an argument

   107      */

   108     boolean requiresArgument();

   109 

   110     /**

   111      * Gives a short {@linkplain ArgumentAcceptingOptionSpec#describedAs(String) description} of the option's argument.

   112      *

   113      * @return a description for the option's argument

   114      */

   115     String argumentDescription();

   116 

   117     /**

   118      * Gives an indication of the {@linkplain ArgumentAcceptingOptionSpec#ofType(Class) expected type} of the option's

   119      * argument.

   120      *

   121      * @return a description for the option's argument type

   122      */

   123     String argumentTypeIndicator();

   124 

   125     /**

   126      * Tells whether this object represents the non-option arguments of a command line.

   127      *

   128      * @return {@code true} if this represents non-option arguments

   129      */

   130     boolean representsNonOptions();

   131 }