org.springframework.shell.standard.ShellOption Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2015 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.shell.standard;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Used to customize handling of a {@link ShellMethod} parameter.
 *
 * @author Eric Bottard
 * @author Florent Biville
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface ShellOption {

	/**
	 * Used to indicate that the default value is the value {@literal null}, which is different from the fact that
	 * there is no default value.
	 */
	String NULL = "__NULL__";

	/**
	 * Used to indicate that there is no default value (i.e. parameter is mandatory).
	 */
	String NONE = "__NONE__";

	/**
	 * Marker value to indicate that heuristics should be used to derive arity.
	 */
	int ARITY_USE_HEURISTICS = -1;

	/**
	 * The key(s) by which this parameter can be referenced
	 * when using named parameters. If none is specified, the actual method parameter name will be used, prefixed by the
	 * method {@link ShellMethod#prefix()}.
	 * @return explicit key(s) to use to pass a value for this parameter
	 */
	String[] value() default {};

	/**
	 * Return the number of input "words" this parameter consumes. Default is 1, except when parameter type is boolean,
	 * in which case it is 0.
	 * @return the number of words to map to this parameter
	 */
	int arity() default ARITY_USE_HEURISTICS;

	/**
	 * The textual (pre-conversion) value to assign to this parameter if no value is provided by the user.
	 * @return the default value for this parameter
	 */
	String defaultValue() default NONE;

	/**
	 * Return a short description of the parameter.
	 * @return description of the parameter
	 */
	String help() default "";

	Class valueProvider() default NoValueProvider.class;

	/**
	 * Used to indicate to the framework that the given parameter should NOT be resolved by
	 * {@code StandardParameterResolver}. This is useful if several implementations of
	 * {@code org.springframework.shell.ParameterResolver} are present, given that the standard one can work with no
	 * annotation at all.
	 * Note that this is not used anymore!
	 * @return true to indicate that the {@code StandardParameterResolver} should not be used for this parameter
	 */
	boolean optOut() default false;

	interface NoValueProvider extends ValueProvider {

	}
}