001 /* 002 * Copyright (C) 2010 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.cmdline.annotations; 021 022 import org.crsh.cmdline.completers.EmptyCompleter; 023 import org.crsh.cmdline.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 * Annotates a field or parameter to become an command line option. 032 * 033 * @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a> 034 * @version $Revision$ 035 */ 036 @Target({ElementType.FIELD,ElementType.PARAMETER,ElementType.ANNOTATION_TYPE}) 037 @Retention(RetentionPolicy.RUNTIME) 038 public @interface Option { 039 040 /** 041 * The option names, when an option name has one letter it will be used as a short switch, when it has 042 * more letter it is considered as a long switch. 043 * 044 * @return the option names 045 */ 046 String[] names(); 047 048 /** 049 * Not yet implemented. 050 * 051 * @return the password value 052 */ 053 boolean password() default false; 054 055 /** 056 * Indicates whether or not the value should be unquoted. 057 * 058 * @return the unquote value 059 */ 060 boolean unquote() default true; 061 062 /** 063 * The completer type to complete this option value. 064 * 065 * @return the completer type 066 */ 067 Class<? extends Completer> completer() default EmptyCompleter.class; 068 069 }