001/*
002 * $RCSfile: Command.java,v $
003 * $Revision: 1.1.2.4 $ $Date: 2009/11/24 22:37:40 $
004 *
005 * Copyright 2009 Kabira Technologies, Inc. All rights reserved.
006 */
007package com.kabira.platform.management;
008
009import java.lang.annotation.Documented;
010import java.lang.annotation.ElementType;
011import java.lang.annotation.Inherited;
012import java.lang.annotation.Retention;
013import java.lang.annotation.RetentionPolicy;
014import java.lang.annotation.Target;
015
016/**
017 * Indicate that this method should be exposed as an command.
018 * Commands must return void, or TargetException will be thrown
019 * when the target is registered.
020 */
021@Documented
022@Inherited
023@Retention(RetentionPolicy.RUNTIME)
024@Target(ElementType.METHOD)
025public @interface Command
026{
027    /**
028     * The description of the command. Used to generate command help message.
029     */
030    String description() default "";
031}