Interface COM.tolstoy.jconfig.AppCommand
All Packages Class Hierarchy This Package Previous Next Index
Interface COM.tolstoy.jconfig.AppCommand
- public interface AppCommand
- extends Object
- extends DumpInfo
Represents a command which can be sent to an application or one of its instances. After
retrieving an AppCommand from an AppFile or an AppProcess, you can add arguments to it,
if desired, and then tell the AppFile or AppProcess to execute the command. In the case
of an AppFile, if the command succeeds, it returns an AppProcess after executing the
command.
-
copyrightString
-
-
kAppCommandOpenApp
- Name of command to open an application with no documents.
-
kAppCommandOpenDoc
- Name of command to open an application with one or more documents.
-
kAppCommandPlay
- Name of command to tell an application to play one or more documents.
-
kAppCommandPrintDoc
- Name of command to tell an application to print one or more documents.
-
kAppCommandQuit
- Name of command to tell an application to quit.
-
addArg(Object)
- Adds 'arg' to the end of the list of this command's arguments.
-
asString()
- Return the command as a string.
-
clearArgs()
- Delete any arguments previously added to the command.
-
getArg(int)
- Returns the indicated argument in this command's argument list.
-
getCommand()
- Return the name of this command.
-
getMaxNumArgs()
- Returns the maximum number of arguments this command can take.
-
getNumArgs()
- Returns the current number of arguments for this command.
-
getPermissibleArgumentType(int)
- Returns an array containing the classes which can be used as arguments for the indicated
position in the argument list.
-
isNumArgsUnlimited()
- Returns whether this command can take an unlimited number of arguments.
-
isSingleInstanceCapable()
- Returns whether this command can be executed without creating a new process.
-
redup()
- Create a new instance of this command ( not a clone ).
copyrightString
public final static String copyrightString
kAppCommandOpenDoc
public final static String kAppCommandOpenDoc
- Name of command to open an application with one or more documents.
kAppCommandOpenApp
public final static String kAppCommandOpenApp
- Name of command to open an application with no documents.
kAppCommandPrintDoc
public final static String kAppCommandPrintDoc
- Name of command to tell an application to print one or more documents.
kAppCommandPlay
public final static String kAppCommandPlay
- Name of command to tell an application to play one or more documents.
kAppCommandQuit
public final static String kAppCommandQuit
- Name of command to tell an application to quit.
getCommand
public abstract String getCommand()
- Return the name of this command.
asString
public abstract String asString()
- Return the command as a string.
redup
public abstract AppCommand redup()
- Create a new instance of this command ( not a clone ).
getMaxNumArgs
public abstract int getMaxNumArgs()
- Returns the maximum number of arguments this command can take. -1 is returned if this command
can take an unlimited number.
addArg
public abstract void addArg(Object arg)
- Adds 'arg' to the end of the list of this command's arguments.
getNumArgs
public abstract int getNumArgs()
- Returns the current number of arguments for this command.
getPermissibleArgumentType
public abstract Class[] getPermissibleArgumentType(int position)
- Returns an array containing the classes which can be used as arguments for the indicated
position in the argument list. If this command does not take commands, null is returned.
clearArgs
public abstract void clearArgs()
- Delete any arguments previously added to the command.
getArg
public abstract Object getArg(int which)
- Returns the indicated argument in this command's argument list. If 'which' is out of range, null
is returned.
isNumArgsUnlimited
public abstract boolean isNumArgsUnlimited()
- Returns whether this command can take an unlimited number of arguments.
isSingleInstanceCapable
public abstract boolean isSingleInstanceCapable()
- Returns whether this command can be executed without creating a new process.
All Packages Class Hierarchy This Package Previous Next Index