javax.activation

Class 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(InputStream is)
Constructor specifying an input stream.
MailcapCommandMap(String fileName)
Constructor specifying a filename.

Method Summary

void
addMailcap(String mailcap)
Adds entries programmatically to the registry.
DataContentHandler
createDataContentHandler(String mimeType)
Returns the DCH for the specified MIME type.
CommandInfo[]
getAllCommands(String mimeType)
Returns all commands for the given MIME type.
CommandInfo
getCommand(String mimeType, String cmdName)
Returns the command with the specified name for the given MIME type.
String[]
getNativeCommands(String mimeType)
Get the native commands for the given MIME type.
CommandInfo[]
getPreferredCommands(String mimeType)
Returns the list of preferred commands for a given MIME type.

Methods inherited from class javax.activation.CommandMap

createDataContentHandler, createDataContentHandler, getAllCommands, getAllCommands, getCommand, getCommand, getDefaultCommandMap, getMimeTypes, getPreferredCommands, getPreferredCommands, setDefaultCommandMap

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MailcapCommandMap

public MailcapCommandMap()
Default constructor.

MailcapCommandMap

public MailcapCommandMap(InputStream is)
Constructor specifying an input stream.
Parameters:
is - the input stream to read mailcap entries from

MailcapCommandMap

public MailcapCommandMap(String fileName)
            throws IOException
Constructor specifying a filename.
Parameters:
fileName - the name of the file to read mailcap entries from

Method Details

addMailcap

public void addMailcap(String mailcap)
Adds entries programmatically to the registry.
Parameters:
mailcap - a mailcap string

createDataContentHandler

public DataContentHandler createDataContentHandler(String mimeType)
Returns the DCH for the specified MIME type.
Overrides:
createDataContentHandler in interface CommandMap
Parameters:
mimeType - the MIME type

getAllCommands

public CommandInfo[] getAllCommands(String mimeType)
Returns all commands for the given MIME type.
Overrides:
getAllCommands in interface CommandMap
Parameters:
mimeType - the MIME type

getCommand

public CommandInfo getCommand(String mimeType,
                              String cmdName)
Returns the command with the specified name for the given MIME type.
Overrides:
getCommand in interface CommandMap
Parameters:
mimeType - the MIME type
cmdName - the command verb

getNativeCommands

public String[] getNativeCommands(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

getPreferredCommands

public CommandInfo[] getPreferredCommands(String mimeType)
Returns the list of preferred commands for a given MIME type.
Overrides:
getPreferredCommands in interface CommandMap
Parameters:
mimeType - the MIME type

MailcapCommandMap.java -- Command map implementation using a mailcap file. Copyright (C) 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.