Package org.apache.zookeeper.cli
Class CliCommand
- java.lang.Object
-
- org.apache.zookeeper.cli.CliCommand
-
- Direct Known Subclasses:
AddAuthCommand
,AddWatchCommand
,CloseCommand
,CreateCommand
,DeleteAllCommand
,DeleteCommand
,DelQuotaCommand
,GetAclCommand
,GetAllChildrenNumberCommand
,GetCommand
,GetConfigCommand
,GetEphemeralsCommand
,ListQuotaCommand
,LsCommand
,ReconfigCommand
,RemoveWatchesCommand
,SetAclCommand
,SetCommand
,SetQuotaCommand
,StatCommand
,SyncCommand
,VersionCommand
,WhoAmICommand
public abstract class CliCommand extends java.lang.Object
base class for all CLI commands
-
-
Constructor Summary
Constructors Constructor Description CliCommand(java.lang.String cmdStr, java.lang.String optionStr)
a CLI command with command string and options.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description void
addToMap(java.util.Map<java.lang.String,CliCommand> cmdMap)
add this command to a map.abstract boolean
exec()
java.lang.String
getCmdStr()
get the string used to call this commandjava.lang.String
getOptionStr()
get the option stringjava.lang.String
getUsageStr()
get a usage string, contains the command and the optionsabstract CliCommand
parse(java.lang.String[] cmdArgs)
parse the command argumentsvoid
setErr(java.io.PrintStream err)
Set err printStream (usable for testing)void
setOut(java.io.PrintStream out)
Set out printStream (usable for testing)void
setZk(ZooKeeper zk)
set the zookeeper instance
-
-
-
Field Detail
-
zk
protected ZooKeeper zk
-
out
protected java.io.PrintStream out
-
err
protected java.io.PrintStream err
-
-
Constructor Detail
-
CliCommand
public CliCommand(java.lang.String cmdStr, java.lang.String optionStr)
a CLI command with command string and options. Using System.out and System.err for printing- Parameters:
cmdStr
- the string used to call this commandoptionStr
- the string used to call this command
-
-
Method Detail
-
setOut
public void setOut(java.io.PrintStream out)
Set out printStream (usable for testing)- Parameters:
out
-
-
setErr
public void setErr(java.io.PrintStream err)
Set err printStream (usable for testing)- Parameters:
err
-
-
setZk
public void setZk(ZooKeeper zk)
set the zookeeper instance- Parameters:
zk
- the ZooKeeper instance.
-
getCmdStr
public java.lang.String getCmdStr()
get the string used to call this command
-
getOptionStr
public java.lang.String getOptionStr()
get the option string
-
getUsageStr
public java.lang.String getUsageStr()
get a usage string, contains the command and the options
-
addToMap
public void addToMap(java.util.Map<java.lang.String,CliCommand> cmdMap)
add this command to a map. Use the command string as key.- Parameters:
cmdMap
-
-
parse
public abstract CliCommand parse(java.lang.String[] cmdArgs) throws CliParseException
parse the command arguments- Parameters:
cmdArgs
-- Returns:
- this CliCommand
- Throws:
CliParseException
-
exec
public abstract boolean exec() throws CliException
- Returns:
- true if command has watch option, false otherwise
- Throws:
CliException
-
-