CommandMap (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.activation
Class CommandMap

java.lang.Object
  javax.activation.CommandMap

Direct Known Subclasses:: MailcapCommandMap

public abstract class CommandMap
extends Object

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.

Constructor Summary

CommandMap()


Method Summary

abstract DataContentHandler createDataContentHandler(String mimeType)
          Locate a DataContentHandler that corresponds to the MIME 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.

static CommandMap getDefaultCommandMap()
          Get the default CommandMap.

abstract CommandInfo[] getPreferredCommands(String mimeType)
          Get the preferred command list from a MIME Type.

static void setDefaultCommandMap(CommandMap commandMap)
          Set the default CommandMap.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CommandMap

public CommandMap()

Method Detail

getDefaultCommandMap

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

setDefaultCommandMap

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

getPreferredCommands

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.

getAllCommands

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.

getCommand

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.

createDataContentHandler

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