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 java.lang.annotation.Retention;
023    import java.lang.annotation.RetentionPolicy;
024    
025    /**
026     * Provides the text for a usage, this method can be used to annotate a command class, a command method or
027     * a command parameter.
028     */
029    @Retention(RetentionPolicy.RUNTIME)
030    public @interface Usage {
031    
032      /**
033       * The usage textvalue.
034       *
035       * @return the usage
036       */
037      String value();
038    }