Module java.desktop
Package javax.print.attribute.standard

Class DocumentName

java.lang.Object
javax.print.attribute.TextSyntax
javax.print.attribute.standard.DocumentName
所有已实现的接口:
Serializable, Cloneable, Attribute, DocAttribute
public final class DocumentName extends TextSyntax implements DocAttribute
类DocumentName是一个打印属性类，一个文本属性，用于指定文档的名称。DocumentName是打印数据（文档）的属性，而不是打印作业的属性。文档的名称是由客户端定义的任意字符串。但是，如果未指定JobName，则应改用DocumentName，这意味着支持指定DocumentName需要报告JobName，反之亦然。有关更多信息，请参见JobName。

IPP兼容性: 字符串值给出IPP名称值。区域设置给出IPP自然语言。由getName()返回的类别名称给出IPP属性名称。

参见:

  • Constructor Details

    • DocumentName

      public DocumentName(String documentName, Locale locale)
      使用给定的文档名称和区域设置构造一个新的文档名称属性。
      参数:
      documentName - 文档名称
      locale - 文本字符串的自然语言。如果解释为默认区域设置，则null由Locale.getDefault()返回
      抛出:
      NullPointerException - 如果documentName为null

  • Method Details

    • equals

      public boolean equals(Object object)
      返回此文档名称属性是否等效于传入的对象。要等效，必须满足以下所有条件:
      1. object不为null。
      2. object是DocumentName类的实例。
      3. 此文档名称属性的基础字符串和object的基础字符串相等。
      4. 此文档名称属性的区域设置和object的区域设置相等。
      覆盖:
      equals 在类 TextSyntax中
      参数:
      object - 要比较的Object
      返回:
      如果object等效于此文档名称属性，则返回true，否则返回false
      参见:

    • getCategory

      public final Class<? extends Attribute> getCategory()
      获取用作此打印属性值的“类别”的打印属性类。

      对于类DocumentName，类别是DocumentName类本身。

      指定者:
      getCategory 在接口 Attribute中
      返回:
      打印属性类（类别），java.lang.Class类的实例

    • getName

      public final String getName()
      获取此属性值是其实例的类别的名称。

      对于类DocumentName，类别名称为"document-name"。

      指定者:
      getName 在接口 Attribute中
      返回:
      属性类别名称