org.crsh.cmdline.annotations.Argument Maven / Gradle / Ivy
/*
* Copyright (C) 2010 eXo Platform SAS.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.crsh.cmdline.annotations;
import org.crsh.cmdline.completers.EmptyCompleter;
import org.crsh.cmdline.spi.Completer;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Annotates a field or parameter to become an command line argument.
*
* @author Julien Viet
* @version $Revision$
*/
@Target({ElementType.FIELD,ElementType.PARAMETER,ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface Argument {
/**
* The argument name, this value is optional and is only used in the documentation.
*
* @return the argument name
*/
String name() default "";
/**
* Not yet implemented.
*
* @return the password value
*/
boolean password() default false;
/**
* Indicates whether or not the value should be unquoted.
*
* @return the unquote value
*/
boolean unquote() default true;
/**
* The completer type to complete this option value.
*
* @return the completer type
*/
Class completer() default EmptyCompleter.class;
}