KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > lib > cvsclient > commandLine > command > CommandProvider


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */

19
20 package org.netbeans.lib.cvsclient.commandLine.command;
21
22 import java.io.PrintStream JavaDoc;
23 import java.util.ResourceBundle JavaDoc;
24
25 import org.netbeans.lib.cvsclient.command.Command;
26 import org.netbeans.lib.cvsclient.command.GlobalOptions;
27
28 /**
29  * The provider of CVS commands.
30  * The implementation of this interface knows how to create a CVS command
31  * from an array of arguments.
32  *
33  * @author Martin Entlicher
34  */

35 public interface CommandProvider {
36
37     /**
38      * Get the name of this command.
39      * The default implementation returns the name of the implementing class.
40      */

41     public String JavaDoc getName();
42     
43     /**
44      * Get the list of synonyms of names of this command.
45      */

46     public abstract String JavaDoc[] getSynonyms();
47     
48     /**
49      * Create the CVS command from an array of arguments.
50      * @param args The array of arguments passed to the command.
51      * @param index The index in the array where the command's arguments start.
52      * @param workDir The working directory.
53      * @return The implementation of the {@link org.netbeans.lib.cvsclient.command.Command}
54      * class, which have set the passed arguments.
55      */

56     public abstract Command createCommand(String JavaDoc[] args, int index, GlobalOptions gopt, String JavaDoc workDir);
57     
58     /**
59      * Get a short string describibg the usage of the command.
60      */

61     public String JavaDoc getUsage();
62     
63     /**
64      * Print a short help description (one-line only) for this command to the
65      * provided print stream.
66      * @param out The print stream.
67      */

68     public void printShortDescription(PrintStream JavaDoc out);
69     
70     /**
71      * Print a long help description (multi-line with all supported switches
72      * and their description) of this command to the provided print stream.
73      * @param out The print stream.
74      */

75     public void printLongDescription(PrintStream JavaDoc out);
76     
77 }
78
Popular Tags