JavaTM 2 Platform
Standard Ed. 6

javax.activation
类 MailcapCommandMap

java.lang.Object
  继承者 javax.activation.CommandMap
      继承者 javax.activation.MailcapCommandMap

public class MailcapCommandMap
extends CommandMap

MailcapCommandMap 扩展 CommandMap 抽象类。它实现配置基于 mailcap 文件 (RFC 1524) 的 CommandMap。可以以编程方式和通过配置文件的方式来配置 MailcapCommandMap。

mailcap 文件搜索顺序:

MailcapCommandMap 在用户系统的各个位置查找 mailcap 文件条目。当发出请求以搜索 MailcapCommandMap 中的命令时,它以下面的顺序搜索 mailcap 文件:

  1. 以编程方式添加到 MailcapCommandMap 实例的条目。
  2. 用户主目录中的 .mailcap 文件。
  3. <java.home>/lib/mailcap 文件。
  4. 名为 META-INF/mailcap 的文件或资源。
  5. 名为 META-INF/mailcap.default 的文件或资源(通常只存在于 activation.jar 文件中)。

mailcap 文件格式:

mailcap 文件必须符合 mailcap 文件规范 (RFC 1524, A User Agent Configuration Mechanism For Multimedia Mail Format Information)。文件格式由与特定 MIME 类型对应的条目组成。一般情况下,当客户机本身不能对指定的 MIME 类型进行操作时,该规范为其指定使用的应用程序。MailcapCommandMap 扩展了此规范,它在 mailcap 文件中使用一个参数机制,该机制允许指定 JavaBeans(tm) 组件对应于 MIME 类型的特定命令。

解析一个 mailcap 文件时,MailcapCommandMap 识别出某些参数签名,特别是以 x-java- 开头的参数名称。MailcapCommandMap 使用此签名查找命令条目,以将其包含到注册表。用名称 name 标识一个命令时,MailcapCommandMap 读取 x-java-<name> 形式的参数名称。当 namecontent-handler 时,MailcapCommandMap 将此参数所表示的类视为 DataContentHandler。所有其他命令的处理通常忽略其命令名。命令实现由 JavaBean(tm) 组件的一个完全限定类名指定。例如,查看某些数据的命令可以被指定为:x-java-view=com.foo.ViewBean

当命令名是 fallback-entry 时,命令的值可以为 truefalse。包含 x-java-fallback-entry=true 参数的 MIME 类型的条目定义了该 MIME 类型的回退 (fallback) 命令,只在找不到非回退条目的情况下才使用该命令。例如,形式为 text/*; ; x-java-fallback-entry=true; x-java-view=com.sun.TextViewer 的条目指定了用于任何文本 MIME 类型的查看命令。此查看命令只在找不到 MIME 类型的非回退查看命令的情况下使用。

支持 MailcapCommandMap 的 mailcap 文件的一般形式如下:

# 注释以 '#' 开头并延续到行的末尾。
<mime type>; ; <parameter list>
# 其中参数列表由一个或多个参数组成,
# 其中参数类似于:x-java-view=com.sun.TextViewer
# 参数列表类似于:
纯文本; ; x-java-view=com.sun.TextViewer; x-java-edit=com.sun.TextEdit
# 注意,不包含 'x-java' 参数的 mailcap 条目
# 和遵守 RFC 1524 的条目将被忽略:
image/gif; /usr/dt/bin/sdtimage %s

从以下版本开始:
1.6

构造方法摘要
MailcapCommandMap()
          默认的构造方法。
MailcapCommandMap(InputStream is)
          允许调用者指定一个包含 mailcap 文件的 InputStream 的构造方法。
MailcapCommandMap(String fileName)
          允许调用者指定 mailcap 文件路径的构造方法。
 
方法摘要
 void addMailcap(String mail_cap)
          将条目添加到注册表。
 DataContentHandler createDataContentHandler(String mimeType)
          返回指定 MIME 类型的 DataContentHandler。
 CommandInfo[] getAllCommands(String mimeType)
          针对此 MIME 类型获取此 MailcapCommandMap 实例已知的所有 mailcap 文件中的所有可用命令。
 CommandInfo getCommand(String mimeType, String cmdName)
          针对 MIME 类型获取与 cmdName 对应的命令。
 String[] getMimeTypes()
          获取此命令映射已知的所有 MIME 类型。
 String[] getNativeCommands(String mimeType)
          获取给定 MIME 类型的本地命令。
 CommandInfo[] getPreferredCommands(String mimeType)
          获取 MIME 类型的首选命令列表。
 
从类 javax.activation.CommandMap 继承的方法
createDataContentHandler, getAllCommands, getCommand, getDefaultCommandMap, getPreferredCommands, setDefaultCommandMap
 
从类 java.lang.Object 继承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

构造方法详细信息

MailcapCommandMap

public MailcapCommandMap()
默认的构造方法。


MailcapCommandMap

public MailcapCommandMap(String fileName)
                  throws IOException
允许调用者指定 mailcap 文件路径的构造方法。

参数:
fileName - 要打开的 mailcap 文件的名称
抛出:
IOException - 如果不能访问该文件

MailcapCommandMap

public MailcapCommandMap(InputStream is)
允许调用者指定一个包含 mailcap 文件的 InputStream 的构造方法。

参数:
is - 要打开的 mailcap 文件的 InputStream
方法详细信息

getPreferredCommands

public CommandInfo[] getPreferredCommands(String mimeType)
获取 MIME 类型的首选命令列表。MailcapCommandMap 以如上所述的 mailcap 文件搜索顺序 来搜索 mailcap 文件。

搜索的结果是此 MailcapCommandMap 实例已知的所有 mailmap 文件中可用命令的适当子集。特定命令的第一个条目被视为首选命令。

指定者:
CommandMap 中的 getPreferredCommands
参数:
mimeType - MIME 类型
返回:
表示首选命令的 CommandInfo 对象。

getAllCommands

public CommandInfo[] getAllCommands(String mimeType)
针对此 MIME 类型获取此 MailcapCommandMap 实例已知的所有 mailcap 文件中的所有可用命令。

指定者:
CommandMap 中的 getAllCommands
参数:
mimeType - MIME 类型
返回:
表示所有命令的 CommandInfo 对象。

getCommand

public CommandInfo getCommand(String mimeType,
                              String cmdName)
针对 MIME 类型获取与 cmdName 对应的命令。

指定者:
CommandMap 中的 getCommand
参数:
mimeType - MIME 类型
cmdName - 命令名
返回:
与命令对应的 CommandInfo 对象。

addMailcap

public void addMailcap(String mail_cap)
将条目添加到注册表。搜索其他条目之前,先搜索以编程方式添加的条目。

传入的字符串应该是 mailcap 格式。

参数:
mail_cap - 已正确格式化的 mailcap 字符串

createDataContentHandler

public DataContentHandler createDataContentHandler(String mimeType)
返回指定 MIME 类型的 DataContentHandler。

指定者:
CommandMap 中的 createDataContentHandler
参数:
mimeType - MIME 类型
返回:
DataContentHandler

getMimeTypes

public String[] getMimeTypes()
获取此命令映射已知的所有 MIME 类型。

覆盖:
CommandMap 中的 getMimeTypes
返回:
字符串形式的 MIME 类型数组
从以下版本开始:
JAF 1.1

getNativeCommands

public String[] getNativeCommands(String mimeType)
获取给定 MIME 类型的本地命令。返回一个字符串数组,其中每个字符串都是一个完整的 mailcap 文件条目。应用程序需要解析条目以提取实际命令以及它需要的所有属性。关于 mailcap 条目语法的详细信息,请参阅 RFC 1524。只返回为指定的 MIME 类型指定查看命令的 mailcap 条目。

返回:
本地命令条目数组
从以下版本开始:
JAF 1.1

JavaTM 2 Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策