org.apache.accumulo.core.util.shell
Class Shell.Command
java.lang.Object
org.apache.accumulo.core.util.shell.Shell.Command
- Direct Known Subclasses:
- Shell.AboutCommand, Shell.AddSplitsCommand, Shell.AuthenticateCommand, Shell.ClasspathCommand, Shell.ClearCommand, Shell.ConfigCommand, Shell.CreateTableCommand, Shell.CreateUserCommand, Shell.DebugCommand, Shell.DeleteCommand, Shell.DeleteIterCommand, Shell.DeleteScanIterCommand, Shell.DeleteTableCommand, Shell.DropUserCommand, Shell.ExecfileCommand, Shell.ExitCommand, Shell.FlushCommand, Shell.FormatterCommand, Shell.GetAuthsCommand, Shell.GetGroupsCommand, Shell.GetSplitsCommand, Shell.GrantCommand, Shell.HelpCommand, Shell.HiddenCommand, Shell.ImportDirectoryCommand, Shell.InsertCommand, Shell.ListScansCommand, Shell.MasterStateCommand, Shell.PasswdCommand, Shell.RenameTableCommand, Shell.RevokeCommand, Shell.ScanCommand, Shell.SelectCommand, Shell.SelectrowCommand, Shell.SetAuthsCommand, Shell.SetGroupsCommand, Shell.SetIterCommand, Shell.SystemPermissionsCommand, Shell.TableCommand, Shell.TablePermissionsCommand, Shell.TablesCommand, Shell.UserCommand, Shell.UserPermissionsCommand, Shell.UsersCommand, Shell.WhoAmICommand
- Enclosing class:
- Shell
public abstract static class Shell.Command
- extends java.lang.Object
The Command class represents a command to be run in the shell. It contains the methods to execute along with some methods to help tab completion, and
return the command name, help, and usage.
Method Summary |
abstract java.lang.String |
description()
|
abstract int |
execute(java.lang.String fullCommand,
org.apache.commons.cli.CommandLine cl,
Shell shellState)
|
java.lang.String |
getName()
|
org.apache.commons.cli.Options |
getOptions()
|
org.apache.commons.cli.Options |
getOptionsWithHelp()
|
abstract int |
numArgs()
|
void |
printHelp()
|
void |
registerCompletion(Token root,
java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> completion_set)
|
void |
registerCompletionForCommands(Token root,
java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> completionSet)
|
void |
registerCompletionForTables(Token root,
java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> completionSet)
|
void |
registerCompletionForUsers(Token root,
java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> completionSet)
|
void |
registerCompletionGeneral(Token root,
java.util.Set<java.lang.String> args,
boolean caseSens)
|
java.lang.String |
usage()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Shell.Command
public Shell.Command()
registerCompletionGeneral
public void registerCompletionGeneral(Token root,
java.util.Set<java.lang.String> args,
boolean caseSens)
registerCompletionForTables
public void registerCompletionForTables(Token root,
java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> completionSet)
registerCompletionForUsers
public void registerCompletionForUsers(Token root,
java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> completionSet)
registerCompletionForCommands
public void registerCompletionForCommands(Token root,
java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> completionSet)
execute
public abstract int execute(java.lang.String fullCommand,
org.apache.commons.cli.CommandLine cl,
Shell shellState)
throws java.lang.Exception
- Throws:
java.lang.Exception
description
public abstract java.lang.String description()
numArgs
public abstract int numArgs()
getName
public java.lang.String getName()
registerCompletion
public void registerCompletion(Token root,
java.util.Map<Shell.Command.CompletionSet,java.util.Set<java.lang.String>> completion_set)
printHelp
public final void printHelp()
getOptionsWithHelp
public final org.apache.commons.cli.Options getOptionsWithHelp()
usage
public java.lang.String usage()
getOptions
public org.apache.commons.cli.Options getOptions()
Copyright © 2012 The Apache Software Foundation. All Rights Reserved.