io.airlift.command.Command Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of airline Show documentation

Airline is a Java annotation-based framework for parsing Git like command line structures.

The newest version!

/**
 * Copyright (C) 2010 the original author or authors.
 * See the notice.md file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * 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 io.airlift.command;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * Marks a class as a command.
 */
@Target(TYPE)
@Retention(RUNTIME)
@Documented
public @interface Command
{
    /**
     * Name of the command.  Command name is split on white space to form a multi-word name.
     */
    String name();

    /**
     * Description of the command.
     */
    String description() default "";

    /**
     * If true, this command won't appear in the usage().
     */
    boolean hidden() default false;

    /**
     *  the group(s) this command should belong to.
     *  if left empty the command will belong to the default command group
     */
    String[] groupNames() default {};
}