001    /*
002     * Copyright (C) 2012 eXo Platform SAS.
003     *
004     * This is free software; you can redistribute it and/or modify it
005     * under the terms of the GNU Lesser General Public License as
006     * published by the Free Software Foundation; either version 2.1 of
007     * the License, or (at your option) any later version.
008     *
009     * This software is distributed in the hope that it will be useful,
010     * but WITHOUT ANY WARRANTY; without even the implied warranty of
011     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012     * Lesser General Public License for more details.
013     *
014     * You should have received a copy of the GNU Lesser General Public
015     * License along with this software; if not, write to the Free
016     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
017     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
018     */
019    
020    package org.crsh.cli;
021    
022    import org.crsh.cli.completers.EmptyCompleter;
023    import org.crsh.cli.spi.Completer;
024    
025    import java.lang.annotation.ElementType;
026    import java.lang.annotation.Retention;
027    import java.lang.annotation.RetentionPolicy;
028    import java.lang.annotation.Target;
029    
030    /**
031     * A command argument.
032     */
033    @Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
034    @Retention(RetentionPolicy.RUNTIME)
035    public @interface Argument {
036    
037      /**
038       * The argument name, this value is optional and is only used in the documentation.
039       *
040       * @return the argument name
041       */
042      String name() default "";
043    
044      /**
045       * Indicates whether or not the value should be unquoted.
046       *
047       * @return the unquote value
048       */
049      boolean unquote() default true;
050    
051      /**
052       * The completer type to complete this option value.
053       *
054       * @return the completer type
055       */
056      Class<? extends Completer> completer() default EmptyCompleter.class;
057    }