public abstract class

CommandMap

extends Object
java.lang.Object
   ↳ com.google.code.javax.activation.CommandMap
Known Direct Subclasses

Class Overview

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.

Summary

Fields
private static CommandMap defaultCommandMap
Public Constructors
CommandMap()
Public Methods
abstract DataContentHandler createDataContentHandler(String mimeType)
Locate a DataContentHandler that corresponds to the MIME type.
DataContentHandler createDataContentHandler(String mimeType, DataSource ds)
Locate a DataContentHandler that corresponds to the MIME type.
CommandInfo[] getAllCommands(String mimeType, DataSource ds)
Get all the available commands for this type.
abstract CommandInfo[] getAllCommands(String mimeType)
Get all the available commands for this type.
abstract CommandInfo getCommand(String mimeType, String cmdName)
Get the default command corresponding to the MIME type.
CommandInfo getCommand(String mimeType, String cmdName, DataSource ds)
Get the default command corresponding to the MIME type.
static CommandMap getDefaultCommandMap()
Get the default CommandMap.
String[] getMimeTypes()
Get all the MIME types known to this command map.
abstract CommandInfo[] getPreferredCommands(String mimeType)
Get the preferred command list from a MIME Type.
CommandInfo[] getPreferredCommands(String mimeType, DataSource ds)
Get the preferred command list from a MIME Type.
static void setDefaultCommandMap(CommandMap commandMap)
Set the default CommandMap.
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private static CommandMap defaultCommandMap

Public Constructors

public CommandMap ()

Public Methods

public abstract 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.

Parameters
mimeType The MIME type
Returns
  • the DataContentHandler for the MIME type

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.

Parameters
mimeType The MIME type
ds A DataSource for the data
Returns
  • the DataContentHandler for the 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.

Parameters
mimeType The MIME type
ds A DataSource for the data
Returns
  • the CommandInfo objects representing all the commands.

public abstract CommandInfo[] getAllCommands (String mimeType)

Get all the available commands for this type. This method should return all the possible commands for this MIME type.

Parameters
mimeType The MIME type
Returns
  • the CommandInfo objects representing all the commands.

public abstract CommandInfo getCommand (String mimeType, String cmdName)

Get the default command corresponding to the MIME type.

Parameters
mimeType The MIME type
cmdName The command name
Returns
  • the CommandInfo corresponding to the command.

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.

Parameters
mimeType The MIME type
cmdName The command name
ds A DataSource for the data
Returns
  • the CommandInfo corresponding to the command.

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.

Returns
  • the CommandMap

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.

Returns
  • array of MIME types as strings, or null if not supported

public abstract CommandInfo[] getPreferredCommands (String mimeType)

Get the preferred command list from a MIME Type. The actual semantics are determined by the implementation of the CommandMap.

Parameters
mimeType The MIME type
Returns
  • the CommandInfo classes that represent the command Beans.

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.

Parameters
mimeType The MIME type
ds A DataSource for the data
Returns
  • the CommandInfo classes that represent the command Beans.

public static void setDefaultCommandMap (CommandMap commandMap)

Set the default CommandMap. Reset the CommandMap to the default by calling this method with null.

Parameters
commandMap The new default CommandMap.
Throws
SecurityException if the caller doesn't have permission to change the default