pw.stamina.mandate.annotations.meta.Usage Maven / Gradle / Ivy

Go to download

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

A fluent command processing system, in the spirit of POSIX

There is a newer version: 3.0.1

/*
 * Mandate - A flexible annotation-based command parsing and execution system
 * Copyright (C) 2017 Mark Johnson
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */

package pw.stamina.mandate.annotations.meta;

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

/**
 * An annotation providing a name, along with usage information for, the annotated command parameter
 * 
 * This should be used primarily to supplement command manager implementations that might choose
 * to provide auto-generated manual pages for registered commands
 *
 * @author Mark Johnson
 */
@Target(value=ElementType.PARAMETER)
@Retention(value=RetentionPolicy.RUNTIME)
public @interface Usage {

    /**
     * @return The preferred name of this parameter
     */
    String name();

    /**
     * A usage string supplementing the definition of the annotated parameter.
     *
     * @return The defined usage help text for this particular parameter
     */
    String usage() default "";
}