Home » Open-JDK-6.b17-src » javax » activation » [javadoc | source]
javax.activation
abstract public class: CommandMap [javadoc | source]
java.lang.Object
   javax.activation.CommandMap

Direct Known Subclasses:
    MailcapCommandMap

The CommandMap class provides an interface to a registry of command objects available in the system. Developers are expected to either use the CommandMap implementation included with this package (MailcapCommandMap) or develop their own. Note that some of the methods in this class are abstract.
Method from javax.activation.CommandMap Summary:
createDataContentHandler,   createDataContentHandler,   getAllCommands,   getAllCommands,   getCommand,   getCommand,   getDefaultCommandMap,   getMimeTypes,   getPreferredCommands,   getPreferredCommands,   setDefaultCommandMap
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.activation.CommandMap Detail:
 abstract public DataContentHandler createDataContentHandler(String mimeType)
    Locate a DataContentHandler that corresponds to the MIME type. The mechanism and semantics for determining this are determined by the implementation of the particular CommandMap.
 public DataContentHandler createDataContentHandler(String mimeType,
    DataSource ds) 
    Locate a DataContentHandler that corresponds to the MIME type. The mechanism and semantics for determining this are determined by the implementation of the particular CommandMap.

    The DataSource provides extra information, such as the file name, that a CommandMap implementation may use to further refine the choice of DataContentHandler. The implementation in this class simply calls the createDataContentHandler method that ignores this argument.

 abstract public CommandInfo[] getAllCommands(String mimeType)
    Get all the available commands for this type. This method should return all the possible commands for this MIME type.
 public CommandInfo[] getAllCommands(String mimeType,
    DataSource ds) 
    Get all the available commands for this type. This method should return all the possible commands for this MIME type.

    The DataSource provides extra information, such as the file name, that a CommandMap implementation may use to further refine the list of commands that are returned. The implementation in this class simply calls the getAllCommands method that ignores this argument.

 abstract public CommandInfo getCommand(String mimeType,
    String cmdName)
    Get the default command corresponding to the MIME type.
 public CommandInfo getCommand(String mimeType,
    String cmdName,
    DataSource ds) 
    Get the default command corresponding to the MIME type.

    The DataSource provides extra information, such as the file name, that a CommandMap implementation may use to further refine the command that is chosen. The implementation in this class simply calls the getCommand method that ignores this argument.

 public static CommandMap getDefaultCommandMap() 
    Get the default CommandMap.

    • In cases where a CommandMap instance has been previously set to some value (via setDefaultCommandMap) return the CommandMap.
    • In cases where no CommandMap has been set, the CommandMap creates an instance of MailcapCommandMap and set that to the default, returning its value.
 public String[] getMimeTypes() 
    Get all the MIME types known to this command map. If the command map doesn't support this operation, null is returned.
 abstract public CommandInfo[] getPreferredCommands(String mimeType)
    Get the preferred command list from a MIME Type. The actual semantics are determined by the implementation of the CommandMap.
 public CommandInfo[] getPreferredCommands(String mimeType,
    DataSource ds) 
    Get the preferred command list from a MIME Type. The actual semantics are determined by the implementation of the CommandMap.

    The DataSource provides extra information, such as the file name, that a CommandMap implementation may use to further refine the list of commands that are returned. The implementation in this class simply calls the getPreferredCommands method that ignores this argument.

 public static  void setDefaultCommandMap(CommandMap commandMap) 
    Set the default CommandMap. Reset the CommandMap to the default by calling this method with null.