A C D E G H I J L M N O P Q R S T

A

AbstractCommand - class org.cli4j.AbstractCommand.
AbstractCommand provides a simplistic base class to extend for creation of customized Command classes.
AbstractCommand() - Constructor for class org.cli4j.AbstractCommand
 
addArgument(String) - Method in class org.cli4j.Node
 
addNode(Node) - Method in class org.cli4j.ParseTree
Add a top level command node to the root of the command tree.
addNode(Node) - Method in class org.cli4j.Node
 
addParseTree(ParseTree) - Method in class org.cli4j.Parser
This method is here solely for the sake of parsing the descriptor file; it should never be called directly.
authenticate(String, String) - Method in class org.cli4j.commands.Login
 

C

CLEAR_COMMAND - Static variable in class org.cli4j.CliDriver
The command the end user executes to clear the console.
CLI_CMD_STICKY_KEY - Static variable in class org.cli4j.CliDriver
 
CliDriver - class org.cli4j.CliDriver.
The CliDriver class is the workhorse of CLI4J.
CliDriver(File) - Constructor for class org.cli4j.CliDriver
 
CliDriver(File, boolean) - Constructor for class org.cli4j.CliDriver
 
CliDriver(File, InputStream, PrintStream) - Constructor for class org.cli4j.CliDriver
 
CliDriver(File, InputStream, PrintStream, boolean) - Constructor for class org.cli4j.CliDriver
 
CliException - exception org.cli4j.CliException.
 
CliException(String) - Constructor for class org.cli4j.CliException
 
CliException(String, Throwable) - Constructor for class org.cli4j.CliException
 
Command - interface org.cli4j.Command.
 
CommandFactory - class org.cli4j.CommandFactory.
 
CommandFactory() - Constructor for class org.cli4j.CommandFactory
 
compareTo(Object) - Method in class org.cli4j.Node
 
containsKey(String) - Method in class org.cli4j.Context
 
Context - class org.cli4j.Context.
 
CONTEXT_UID_KEY - Static variable in class org.cli4j.commands.Login
 
Context(InputStream, PrintStream) - Constructor for class org.cli4j.Context
 
createCommand(String) - Method in class org.cli4j.CommandFactory
 

D

DEFAULT_EXIT_COMMAND - Static variable in class org.cli4j.ParseTree
The default command executed by the user to break out of a "sticky" command; this value is overriden by the exitCommand attribute of the command-tree element.
Dynamic - class org.cli4j.commands.Dynamic.
 
Dynamic() - Constructor for class org.cli4j.commands.Dynamic
 
DynCmd - class org.cli4j.commands.DynCmd.
 
DynCmd() - Constructor for class org.cli4j.commands.DynCmd
 

E

equals(Object) - Method in class org.cli4j.Node
 
execute(Context, String[]) - Method in class org.cli4j.AbstractCommand
 
execute(Context, String[]) - Method in interface org.cli4j.Command
 
execute(Context, String[]) - Method in class org.cli4j.NullCommand
 
execute(Context, String[]) - Method in class org.cli4j.commands.Dynamic
 
execute(Context, String[]) - Method in class org.cli4j.commands.DynCmd
 
execute(Context, String[]) - Method in class org.cli4j.commands.Login
 
execute(Context, String[]) - Method in class org.cli4j.commands.SystemLauncher
 
execute(Context, String[]) - Method in class org.cli4j.commands.Shutdown
 

G

get(String) - Method in class org.cli4j.Context
 
getArguments() - Method in class org.cli4j.Node
 
getBriefHelp() - Method in class org.cli4j.Node
 
getCause() - Method in class org.cli4j.CliException
 
getCommand() - Method in class org.cli4j.Node
 
getContext() - Method in class org.cli4j.CliDriver
 
getCurrentNode() - Method in class org.cli4j.Context
 
getExitCommand() - Method in class org.cli4j.ParseTree
Get the command the user executes to "break out" of a sticky command; if there is no sticky command, exit the application.
getFork() - Method in class org.cli4j.Node
 
getHelp() - Method in class org.cli4j.ParseTree
 
getHelp() - Method in class org.cli4j.Node
 
getInitCommandClass() - Method in class org.cli4j.ParseTree
Get the fully qualified class name that implements the Command interface to execute after the command tree is parsed and then initialized.
getInputAsReader() - Method in class org.cli4j.Context
 
getInputStream() - Method in class org.cli4j.Context
 
getName() - Method in class org.cli4j.ParseTree
Get the name of the application.
getName() - Method in class org.cli4j.Node
 
getNode(String) - Method in class org.cli4j.Node
 
getNodeNames() - Method in class org.cli4j.Node
 
getNodes() - Method in class org.cli4j.ParseTree
Get all of the top level command nodes.
getNodes() - Method in class org.cli4j.Node
 
getParent() - Method in class org.cli4j.Node
 
getPrintStream() - Method in class org.cli4j.Context
 
getPrompt() - Method in class org.cli4j.ParseTree
Get the default console prompt.
getRoot() - Method in class org.cli4j.ParseTree
The root node.
getShowSubCommands() - Method in class org.cli4j.Node
 
getShutdownCommandClass() - Method in class org.cli4j.ParseTree
 
getSticky() - Method in class org.cli4j.Node
 
getSystem() - Method in class org.cli4j.Node
 

H

hashCode() - Method in class org.cli4j.Node
 
HELP_COMMAND - Static variable in class org.cli4j.CliDriver
The command the end user executes to obtain online help if any is available.

I

IDENT - Static variable in interface org.cli4j.Command
The Id string used by the RSC identity and SCCS what commands to determine the version of a class or interface; typically not for public consumption.

J

join(String[], String) - Static method in class org.cli4j.util.StringUtils
Constructs a single string by concatenating the args array element with the joinStr between each element.

L

log(String) - Method in class org.cli4j.Context
 
Login - class org.cli4j.commands.Login.
 
Login() - Constructor for class org.cli4j.commands.Login
 

M

main(String[]) - Static method in class org.cli4j.CliDriver
 

N

newInstance() - Static method in class org.cli4j.CommandFactory
 
Node - class org.cli4j.Node.
 
Node() - Constructor for class org.cli4j.Node
 
NullCommand - class org.cli4j.NullCommand.
This class is an implementation of the Null Object Pattern.
NullCommand() - Constructor for class org.cli4j.NullCommand
 

O

org.cli4j - package org.cli4j
 
org.cli4j.commands - package org.cli4j.commands
 
org.cli4j.util - package org.cli4j.util
 

P

parse() - Method in class org.cli4j.Parser
Parse the default input file to create a ParseTree representation of the command hierarchy.
parse(File) - Method in class org.cli4j.Parser
Parse the inputFile to create the ParseTree representation of the command hierarchy.
parseCmdArgs(String[]) - Static method in class org.cli4j.util.StringUtils
Scan an array of stirngs, where argument names start with a dash ("-") and values are the next element in the array if it does not start with an dash.
ParseException - exception org.cli4j.ParseException.
 
ParseException(String) - Constructor for class org.cli4j.ParseException
 
ParseException(String, Throwable) - Constructor for class org.cli4j.ParseException
 
Parser - class org.cli4j.Parser.
The Parser class is responsible for creating the command hierarchy parse tree.
Parser() - Constructor for class org.cli4j.Parser
Construct a parser without a default input file.
Parser(File) - Constructor for class org.cli4j.Parser
Create a parser with a default input file.
ParseTree - class org.cli4j.ParseTree.
The ParseTree class models the command tree parsed from the command.xml file.
ParseTree() - Constructor for class org.cli4j.ParseTree
Create a new, empty parse tree.
put(String, Object) - Method in class org.cli4j.Context
 

Q

QUIT_COMMAND - Static variable in class org.cli4j.CliDriver
The command the end user executes to leave the CLI immediately.

R

remove(String) - Method in class org.cli4j.Context
 
resolve(String) - Method in class org.cli4j.Context
 
run() - Method in class org.cli4j.CliDriver
 
run() - Method in class org.cli4j.StreamPumper
Copies data from the input stream to the output stream.

S

setBriefHelp(String) - Method in class org.cli4j.Node
 
setDebug(boolean) - Method in class org.cli4j.Parser
Enable debugging messages while parsing the XML command hierarchy descriptor.
setDebugWriter(PrintWriter) - Method in class org.cli4j.Parser
 
setExitCommand(String) - Method in class org.cli4j.ParseTree
Set the command the user executes to "break out" of a sticky command.
setFork(boolean) - Method in class org.cli4j.Node
 
setHelp(String) - Method in class org.cli4j.ParseTree
 
setHelp(String) - Method in class org.cli4j.Node
 
setInitCommandClass(String) - Method in class org.cli4j.ParseTree
Sets the fully qualified class name that implements the Command interface to execute after the command tree is parsed then initialized.
setJava(String) - Method in class org.cli4j.Node
 
setLogStream(PrintStream) - Method in class org.cli4j.Context
 
setName(String) - Method in class org.cli4j.ParseTree
Set the application name.
setName(String) - Method in class org.cli4j.Node
 
setPrompt(String) - Method in class org.cli4j.ParseTree
Set the default prompt.
setShowSubCommands(boolean) - Method in class org.cli4j.Node
 
setShutdownCommandClass(String) - Method in class org.cli4j.ParseTree
 
setSticky(boolean) - Method in class org.cli4j.Node
 
setSystem(String) - Method in class org.cli4j.Node
 
Shutdown - class org.cli4j.commands.Shutdown.
This is a sample class that really doesn't do anything; it here primarily to demonstrate that a Command can be run at shutdown, after all the other commands have been stopped.
Shutdown() - Constructor for class org.cli4j.commands.Shutdown
 
start(Context) - Method in class org.cli4j.AbstractCommand
 
start(Context) - Method in interface org.cli4j.Command
 
start(Context) - Method in class org.cli4j.commands.Dynamic
 
start(Context) - Method in class org.cli4j.commands.DynCmd
 
start(Context) - Method in class org.cli4j.commands.Login
 
start(Context) - Method in class org.cli4j.commands.Shutdown
 
stop(Context) - Method in class org.cli4j.AbstractCommand
 
stop(Context) - Method in interface org.cli4j.Command
 
stop(Context) - Method in class org.cli4j.commands.DynCmd
 
stop(Context) - Method in class org.cli4j.commands.Shutdown
 
StreamPumper - class org.cli4j.StreamPumper.
Copies all data from an input stream to an output stream.
StreamPumper(InputStream, OutputStream) - Constructor for class org.cli4j.StreamPumper
Create a new stream pumper.
StringUtils - class org.cli4j.util.StringUtils.
A collection of useful string utility functions.
StringUtils() - Constructor for class org.cli4j.util.StringUtils
 
SystemLauncher - class org.cli4j.commands.SystemLauncher.
 
SystemLauncher() - Constructor for class org.cli4j.commands.SystemLauncher
 

T

toString() - Method in class org.cli4j.Node
 

A C D E G H I J L M N O P Q R S T