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
020package org.crsh.cli;
021
022import org.crsh.cli.completers.EmptyCompleter;
023import org.crsh.cli.spi.Completer;
024
025import java.lang.annotation.ElementType;
026import java.lang.annotation.Retention;
027import java.lang.annotation.RetentionPolicy;
028import java.lang.annotation.Target;
029
030/**
031 * An option command parameter.
032 */
033@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.ANNOTATION_TYPE})
034@Retention(RetentionPolicy.RUNTIME)
035public @interface Option {
036
037  /**
038   * The option names, when an option name has a single letter it will be used as a short switch, when it has
039   * two letters or more it is considered as a long switch.
040   *
041   * @return the option names
042   */
043  String[] names();
044
045  /**
046   * Indicates whether or not the value should be unquoted.
047   *
048   * @return the unquote value
049   */
050  boolean unquote() default true;
051
052  /**
053   * The completer type to complete this option value.
054   *
055   * @return the completer type
056   */
057  Class<? extends Completer> completer() default EmptyCompleter.class;
058
059}