javax.activation
Class MailcapCommandMap

java.lang.Object
  extended by javax.activation.CommandMap
      extended by javax.activation.MailcapCommandMap

public class MailcapCommandMap
extends CommandMap

Implementation of a command map using a mailcap file (RFC 1524). Mailcap files are searched for in the following places:

  1. Programmatically added entries to this interface
  2. the file .mailcap in the user's home directory
  3. the file <java.home>/lib/mailcap
  4. the resource META-INF/mailcap
  5. the resource META-INF/mailcap.default in the JAF distribution


Constructor Summary
MailcapCommandMap()
          Default constructor.
MailcapCommandMap(java.io.InputStream is)
          Constructor specifying an input stream.
MailcapCommandMap(java.lang.String fileName)
          Constructor specifying a filename.
 
Method Summary
 void addMailcap(java.lang.String mail_cap)
          Adds entries programmatically to the registry.
 DataContentHandler createDataContentHandler(java.lang.String mimeType)
          Returns the DCH for the specified MIME type.
 CommandInfo[] getAllCommands(java.lang.String mimeType)
          Returns all commands for the given MIME type.
 CommandInfo getCommand(java.lang.String mimeType, java.lang.String cmdName)
          Returns the command with the specified name for the given MIME type.
 java.lang.String[] getNativeCommands(java.lang.String mimeType)
          Get the native commands for the given MIME type.
 CommandInfo[] getPreferredCommands(java.lang.String mimeType)
          Returns the list of preferred commands for a given MIME type.
 
Methods inherited from class javax.activation.CommandMap
createDataContentHandler, getAllCommands, getCommand, getDefaultCommandMap, getMimeTypes, getPreferredCommands, setDefaultCommandMap
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MailcapCommandMap

public MailcapCommandMap()
Default constructor.


MailcapCommandMap

public MailcapCommandMap(java.lang.String fileName)
                  throws java.io.IOException
Constructor specifying a filename.

Parameters:
fileName - the name of the file to read mailcap entries from
Throws:
java.io.IOException

MailcapCommandMap

public MailcapCommandMap(java.io.InputStream is)
Constructor specifying an input stream.

Parameters:
is - the input stream to read mailcap entries from
Method Detail

getPreferredCommands

public CommandInfo[] getPreferredCommands(java.lang.String mimeType)
Returns the list of preferred commands for a given MIME type.

Specified by:
getPreferredCommands in class CommandMap
Parameters:
mimeType - the MIME type

getAllCommands

public CommandInfo[] getAllCommands(java.lang.String mimeType)
Returns all commands for the given MIME type.

Specified by:
getAllCommands in class CommandMap
Parameters:
mimeType - the MIME type

getCommand

public CommandInfo getCommand(java.lang.String mimeType,
                              java.lang.String cmdName)
Returns the command with the specified name for the given MIME type.

Specified by:
getCommand in class CommandMap
Parameters:
mimeType - the MIME type
cmdName - the command verb

addMailcap

public void addMailcap(java.lang.String mail_cap)
Adds entries programmatically to the registry.

Parameters:
mail_cap - a mailcap string

createDataContentHandler

public DataContentHandler createDataContentHandler(java.lang.String mimeType)
Returns the DCH for the specified MIME type.

Specified by:
createDataContentHandler in class CommandMap
Parameters:
mimeType - the MIME type

getNativeCommands

public java.lang.String[] getNativeCommands(java.lang.String mimeType)
Get the native commands for the given MIME type. Returns an array of strings where each string is an entire mailcap file entry. The application will need to parse the entry to extract the actual command as well as any attributes it needs. See RFC 1524 for details of the mailcap entry syntax. Only mailcap entries that specify a view command for the specified MIME type are returned.

Returns:
array of native command entries
Since:
JAF 1.1