Java tutorial
/* * Copyright (c) 2011-2019 Contributors to the Eclipse Foundation * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License 2.0 which is available at * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0 * which is available at https://www.apache.org/licenses/LICENSE-2.0. * * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0 */ package io.vertx.core.cli; import io.vertx.codegen.annotations.GenIgnore; import io.vertx.codegen.annotations.Nullable; import io.vertx.codegen.annotations.VertxGen; import io.vertx.core.cli.impl.DefaultCommandLine; import java.util.List; /** * The parser transforms a CLI (a model) into an {@link CommandLine}. This {@link CommandLine} * has stored the argument and option values. Only instance of parser should create * objects of this type. * * @author Clement Escoffier <clement@apache.org> */ @VertxGen public interface CommandLine { /** * Creates a command line object from the {@link CLI}. This object is intended to be used by * the parser to set the argument and option values. * * @param cli the CLI definition * @return the command line object */ static CommandLine create(CLI cli) { return new DefaultCommandLine(cli); } /** * @return the model of this command line object. */ CLI cli(); /** * @return the ordered list of arguments. Arguments are command line arguments not matching an option. */ List<String> allArguments(); /** * Gets the value of an option with the matching name (can be the long name, short name or arg name). * * @param name the name * @param <T> the expected type * @return the value, {@code null} if not set */ @Nullable <T> T getOptionValue(String name); /** * Gets the value of an argument with the matching name (arg name). * * @param name the name * @param <T> the expected type * @return the value, {@code null} if not set */ @Nullable <T> T getArgumentValue(String name); /** * Gets the value of an argument with the given index. * * @param index the index * @param <T> the expected type * @return the value, {@code null} if not set */ @Nullable <T> T getArgumentValue(int index); /** * Gets the values of an option with the matching name (can be the long name, short name or arg name). * * @param name the name * @param <T> the expected component type * @return the values, {@code null} if not set * @see #getRawValuesForOption(Option) */ @GenIgnore <T> List<T> getOptionValues(String name); /** * Gets the values of an argument with the matching index. * * @param index the index * @param <T> the expected component type * @return the values, {@code null} if not set * @see #getArgumentValue(int) * @see #getRawValueForArgument(Argument) */ @GenIgnore <T> List<T> getArgumentValues(int index); /** * Gets the value of an option marked as a flag. * <p/> * Calling this method an a non-flag option throws an {@link IllegalStateException}. * * @param name the option name * @return {@code true} if the flag has been set in the command line, {@code false} otherwise. */ boolean isFlagEnabled(String name); /** * Checks whether or not the given option has been assigned in the command line. * * @param option the option * @return {@code true} if the option has received a value, {@link false} otherwise. */ boolean isOptionAssigned(Option option); /** * Gets the raw values of the given option. Raw values are simple "String", not converted to the option type. * * @param option the option * @return the list of values, empty if none * @deprecated use {@link #getRawValuesForOption(Option)} */ @Deprecated default List<String> getRawValues(Option option) { return getRawValuesForOption(option); } /** * Gets the raw values of the given option. Raw values are simple "String", not converted to the option type. * * @param option the option * @return the list of values, empty if none */ List<String> getRawValuesForOption(Option option); /** * Gets the raw values of the given argument. Raw values are simple "String", not converted to the argument type. * * @param argument the argument * @return the list of values, empty if none */ List<String> getRawValuesForArgument(Argument argument); /** * Gets the raw value of the given option. Raw values are the values as given in the user command line. * * @param option the option * @return the value, {@code null} if none. */ @Nullable String getRawValueForOption(Option option); /** * Checks whether or not the given option accept more values. * * @param option the option * @return {@link true} if the option accepts more values, {@link false} otherwise. */ boolean acceptMoreValues(Option option); /** * Gets the raw value of the given argument. Raw values are the values as given in the user command line. * * @param arg the argument * @return the value, {@code null} if none. */ @Nullable String getRawValueForArgument(Argument arg); /** * Checks whether or not the given argument has been assigned in the command line. * * @param arg the argument * @return {@code true} if the argument has received a value, {@link false} otherwise. */ boolean isArgumentAssigned(Argument arg); /** * Checks whether or not the given option has been seen in the user command line. * * @param option the option * @return {@code true} if the user command line has used the option */ boolean isSeenInCommandLine(Option option); /** * Checks whether or not the command line is valid, i.e. all constraints from arguments and options have been * satisfied. This method is used when the parser validation is disabled. * * @return {@code true} if the current {@link CommandLine} object is valid. {@link false} otherwise. */ boolean isValid(); /** * Checks whether or not the user has passed a "help" option and is asking for help. * * @return {@code true} if the user command line has enabled a "Help" option, {@link false} otherwise. */ boolean isAskingForHelp(); }