KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > enterprise > cli > framework > ICommand


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */

23
24 package com.sun.enterprise.cli.framework;
25
26 import java.util.Vector JavaDoc;
27
28 /**
29  * The interface class for command objects
30  * @version $Revision: 1.3 $
31  */

32 public interface ICommand
33 {
34
35     /**
36      * Returns the name of the command
37      */

38     public String JavaDoc getName();
39     
40
41     /**
42      * Sets the name of this command
43      */

44     public void setName(String JavaDoc name);
45
46
47     /**
48      * Get Usage Text from the command
49      */

50     public String JavaDoc getUsageText();
51
52
53     /**
54      * Set Usage Text for the command
55      */

56     public void setUsageText(String JavaDoc usageText);
57
58     /**
59      * Searches for the property with the specified
60      * key in this properties list
61      * @return the property
62      */

63     public Object JavaDoc getProperty(String JavaDoc key);
64
65
66     /**
67      * Sets the properties of the command
68      * @param key
69      * @param value
70      */

71     public void setProperty(String JavaDoc key, Object JavaDoc value);
72
73
74 }
75
76
Popular Tags