org.deephacks.tools4j.cli.CliExtension Maven / Gradle / Ivy

Go to download
/**
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.deephacks.tools4j.cli;

import java.lang.annotation.ElementType;
import java.lang.annotation.Inherited;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * This class is used to define the name and usage of a particular command.
 * 
 * {@link CliCommand} implementations must be annotated with this annotation. 
 *  
 * @author Kristoffer Sjogren
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
@Inherited
public @interface CliExtension {
    /**
     * This is the keyword that triggers this command from a terminal.
     * 
     * @return The command trigger keyword.
     */
    String keyword();

    /**
     * General and descriptive useage information regarding this command. This information 
     * will be used to display help screens and maybe in product documentation to administrative 
     * personell.  
     *  
     * @return Informative usage information.
     */
    String usage();
}