KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > jbet > Command


1 /*
2  * JBET - Java Binary Enhancement Tool
3  * Copyright (c) 2003 Networks Associates Technology, Inc.
4  *
5  * This software was developed under DARPA/SPAWAR contract
6  * N66001-00-C-8602 "SPMA" as part of the
7  * DARPA OASIS research program.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in the
16  * documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  */
30
31 /*
32    Command object called by Jbet.doCommands().
33    run() parses the input using the supplied lexer. Jbet contains a
34    hashtable of (name, command instance) pairs.
35
36    @author Andrew Reisse
37    @see jbet.cmd.* (implementors)
38 */
39
40 package jbet;
41
42 public interface Command
43 {
44     void run (Lexer l) throws Exception JavaDoc; /* run this command. read arguments from L. Don't read the
45                         trailing EOF or semicolon. */
46
47     int helplevel(); /* how likely a user is to want to use this command.
48                'jbet help' lists only commands with helplevel < 3.
49                'jbet help all' lists everything. */
50
51     String JavaDoc shorthelp(); /* one-line help. The returned string should look like this:
52                "Print info on a class"
53                and be no more than 62 characters. */
54
55     String JavaDoc longhelp(); /* full help, returned string can include newlines. It should
56                look like this (with extra lines if needed):
57                "jbet print <class> Print info on a class
58                ". Include the trailing newline.
59             */
60 }
61
Popular Tags