001/*
002 * (C) Copyright 2006-2010 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     bstefanescu
018 */
019package org.nuxeo.shell;
020
021import java.lang.annotation.ElementType;
022import java.lang.annotation.Retention;
023import java.lang.annotation.RetentionPolicy;
024import java.lang.annotation.Target;
025
026import jline.Completor;
027
028/**
029 * @author <a href="mailto:[email protected]">Bogdan Stefanescu</a>
030 */
031@Retention(RetentionPolicy.RUNTIME)
032@Target({ ElementType.FIELD, ElementType.METHOD })
033public @interface Argument {
034
035    String name();
036
037    int index();
038
039    boolean required() default false;
040
041    String help();
042
043    Class<? extends Completor> completor() default Completor.class;
044}