Interface COM.tolstoy.jconfig.AppCommand
All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface COM.tolstoy.jconfig.AppCommand

public interface AppCommand
extends Object
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.

Variable Index

 o copyrightString
 o kAppCommandOpenApp
Name of command to open an application with no documents.
 o kAppCommandOpenDoc
Name of command to open an application with one or more documents.
 o kAppCommandPlay
Name of command to tell an application to play one or more documents.
 o kAppCommandPrintDoc
Name of command to tell an application to print one or more documents.
 o kAppCommandQuit
Name of command to tell an application to quit.

Method Index

 o addArg(Object)
Adds 'arg' to the end of the list of this command's arguments.
 o asString()
Return the command as a string.
 o clearArgs()
Delete any arguments previously added to the command.
 o dumpInfo(PrintStream, String)
Writes information about this object to the indicated PrintStream.
 o getArg(int)
Returns the indicated argument in this command's argument list.
 o getCommand()
Return the name of this command.
 o getMaxNumArgs()
Returns the maximum number of arguments this command can take.
 o getNumArgs()
Returns the current number of arguments for this command.
 o getPermissibleArgumentType(int)
Returns an array containing the classes which can be used as arguments for the indicated position in the argument list.
 o isNumArgsUnlimited()
Returns whether this command can take an unlimited number of arguments.
 o isSingleInstanceCapable()
Returns whether this command can be executed without creating a new process.
 o redup()
Create a new instance of this command ( not a clone ).

Variables

 o copyrightString
  public final static String copyrightString
 o kAppCommandOpenDoc
  public final static String kAppCommandOpenDoc
Name of command to open an application with one or more documents.
 o kAppCommandOpenApp
  public final static String kAppCommandOpenApp
Name of command to open an application with no documents.
 o kAppCommandPrintDoc
  public final static String kAppCommandPrintDoc
Name of command to tell an application to print one or more documents.
 o kAppCommandPlay
  public final static String kAppCommandPlay
Name of command to tell an application to play one or more documents.
 o kAppCommandQuit
  public final static String kAppCommandQuit
Name of command to tell an application to quit.

Methods

 o getCommand
  public abstract String getCommand()
Return the name of this command.
 o asString
  public abstract String asString()
Return the command as a string.
 o redup
  public abstract AppCommand redup()
Create a new instance of this command ( not a clone ).
 o 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.
 o addArg
  public abstract void addArg(Object arg)
Adds 'arg' to the end of the list of this command's arguments.
 o getNumArgs
  public abstract int getNumArgs()
Returns the current number of arguments for this command.
 o 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.
 o clearArgs
  public abstract void clearArgs()
Delete any arguments previously added to the command.
 o 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.
 o isNumArgsUnlimited
  public abstract boolean isNumArgsUnlimited()
Returns whether this command can take an unlimited number of arguments.
 o isSingleInstanceCapable
  public abstract boolean isSingleInstanceCapable()
Returns whether this command can be executed without creating a new process.
 o dumpInfo
  public abstract void dumpInfo(PrintStream ps,
                                String indent)
Writes information about this object to the indicated PrintStream. Each line will be preceded with the 'indent' argument.

All Packages  Class Hierarchy  This Package  Previous  Next  Index