com.arangodb.shaded.vertx.core.cli.annotations.Argument Maven / Gradle / Ivy
/*
* 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 com.arangodb.shaded.vertx.core.cli.annotations;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotates a setter to be called with the value of a command line argument.
*
* @author Clement Escoffier
* @see Option
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Argument {
/**
* The name of this argument (used in doc)
*/
String argName() default "value";
/**
* The (0-based) position of this argument relative to the argument list. The first parameter has the index 0,
* the second 1...
*
* Index is mandatory to force you to think to the order.
*/
int index();
/**
* Whether or not the argument is required. An argument is required by default.
*/
boolean required() default true;
}