Jakarta Activation API 2.1.2 · jakarta.activation.CommandMap

Modifier and Type	Field and Description
private static CommandMap	defaultCommandMap
private static Map<ClassLoader, CommandMap>	map

Access	Constructor and Description
protected	CommandMap() Default (empty) constructor.

Method Summary

Modifier and Type	Method and Description
public abstract DataContentHandler	Returns: the DataContentHandler for the MIME type createDataContentHandler(String the MIME type mimeType) Locate a DataContentHandler that corresponds to the MIME type.
public DataContentHandler	Returns: the DataContentHandler for the MIME type createDataContentHandler(String the MIME type mimeType, DataSource a DataSource for the data ds) Locate a DataContentHandler that corresponds to the MIME type.
public abstract CommandInfo[]	Returns: the CommandInfo objects representing all the commands. getAllCommands(String the MIME type mimeType) Get all the available commands for this type.
public CommandInfo[]	Returns: the CommandInfo objects representing all the commands. getAllCommands(String the MIME type mimeType, DataSource a DataSource for the data ds) Get all the available commands for this type.
public abstract CommandInfo	Returns: the CommandInfo corresponding to the command. getCommand(String the MIME type mimeType, String the command name cmdName) Get the default command corresponding to the MIME type.
public CommandInfo	Returns: the CommandInfo corresponding to the command. getCommand(String the MIME type mimeType, String the command name cmdName, DataSource a DataSource for the data ds) Get the default command corresponding to the MIME type.
public static synchronized CommandMap	Returns: the CommandMap getDefaultCommandMap() Get the default CommandMap.
public String[]	Returns: array of MIME types as strings, or null if not supported getMimeTypes() Get all the MIME types known to this command map.
public abstract CommandInfo[]	Returns: the CommandInfo classes that represent the command Beans. getPreferredCommands(String the MIME type mimeType) Get the preferred command list from a MIME Type.
public CommandInfo[]	Returns: the CommandInfo classes that represent the command Beans. getPreferredCommands(String the MIME type mimeType, DataSource a DataSource for the data ds) Get the preferred command list from a MIME Type.
public static synchronized void	setDefaultCommandMap(CommandMap The new default CommandMap. commandMap) Set the default CommandMap.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

defaultCommandMap	back to summary
private static CommandMap defaultCommandMap

map	back to summary
private static Map<ClassLoader, CommandMap> map

CommandMap	back to summary
protected CommandMap() Default (empty) constructor.

Method Detail

createDataContentHandler	back to summary
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:String the MIME type Returns:DataContentHandler the DataContentHandler for the MIME type

createDataContentHandler

back to summary

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:String: the MIME type

Returns:DataContentHandler

the DataContentHandler for the MIME type

createDataContentHandler back to summary

createDataContentHandler	back to summary
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:String the MIME type ds:DataSource a DataSource for the data Returns:DataContentHandler the DataContentHandler for the MIME type Since JAF 1.1

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:String: the MIME type
ds:DataSource: a DataSource for the data

Returns:DataContentHandler

the DataContentHandler for the MIME type

Since

JAF 1.1

getAllCommands	back to summary
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:String the MIME type Returns:CommandInfo[] the CommandInfo objects representing all the commands.

getAllCommands

back to summary

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:String: the MIME type

Returns:CommandInfo[]

the CommandInfo objects representing all the commands.

getAllCommands back to summary

getAllCommands	back to summary
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:String the MIME type ds:DataSource a DataSource for the data Returns:CommandInfo[] the CommandInfo objects representing all the commands. Since JAF 1.1

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:String: the MIME type
ds:DataSource: a DataSource for the data

Returns:CommandInfo[]

the CommandInfo objects representing all the commands.

Since

JAF 1.1

getCommand	back to summary
public abstract CommandInfo getCommand(String mimeType, String cmdName) Get the default command corresponding to the MIME type. Parameters mimeType:String the MIME type cmdName:String the command name Returns:CommandInfo the CommandInfo corresponding to the command.

getCommand

back to summary

public abstract CommandInfo getCommand(String mimeType, String cmdName)

Get the default command corresponding to the MIME type.

Parameters

mimeType:String: the MIME type
cmdName:String: the command name

Returns:CommandInfo

the CommandInfo corresponding to the command.

getCommand back to summary

getCommand	back to summary
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:String the MIME type cmdName:String the command name ds:DataSource a DataSource for the data Returns:CommandInfo the CommandInfo corresponding to the command. Since JAF 1.1

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:String: the MIME type
cmdName:String: the command name
ds:DataSource: a DataSource for the data

Returns:CommandInfo

the CommandInfo corresponding to the command.

Since

JAF 1.1

getDefaultCommandMap back to summary

getDefaultCommandMap	back to summary
public static synchronized 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:CommandMap the CommandMap

public static synchronized 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:CommandMap: the CommandMap

getMimeTypes	back to summary
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:String[] array of MIME types as strings, or null if not supported Since JAF 1.1

getMimeTypes

back to summary

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:String[]: array of MIME types as strings, or null if not supported
Since: JAF 1.1

getPreferredCommands	back to summary
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:String the MIME type Returns:CommandInfo[] the CommandInfo classes that represent the command Beans.

getPreferredCommands

back to summary

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:String: the MIME type

Returns:CommandInfo[]

the CommandInfo classes that represent the command Beans.

getPreferredCommands back to summary

getPreferredCommands	back to summary
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:String the MIME type ds:DataSource a DataSource for the data Returns:CommandInfo[] the CommandInfo classes that represent the command Beans. Since JAF 1.1

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.

Parameters

mimeType:String: the MIME type
ds:DataSource: a DataSource for the data

Returns:CommandInfo[]

the CommandInfo classes that represent the command Beans.

Since

JAF 1.1

setDefaultCommandMap back to summary

setDefaultCommandMap	back to summary
public static synchronized void setDefaultCommandMap(CommandMap commandMap) Set the default CommandMap. Reset the CommandMap to the default by calling this method with `null`. Parameters commandMap:CommandMap The new default CommandMap. Exceptions SecurityException: if the caller doesn't have permission to change the default

public static synchronized void setDefaultCommandMap(CommandMap commandMap)

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

Parameters

commandMap:CommandMap: The new default CommandMap.

Exceptions

SecurityException:: if the caller doesn't have permission to change the default

public abstract Class CommandMap

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail