モジュール java.desktop
パッケージ 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属性の名前を示します。

    関連項目:
    直列化された形式

    • コンストラクタのサマリー

      コンストラクタ 
      コンストラクタ 説明
      DocumentName​(String documentName, Locale locale)
      指定されたドキュメントの名前とロケールで、新しいドキュメントの名前属性を構築します。

    • メソッドのサマリー

      修飾子と型 メソッド 説明
      boolean equals​(Object object)
      このドキュメントの名前属性がオブジェクトに渡された属性と等しいかどうかを返します。
      Class<? extends Attribute> getCategory()
      この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
      String getName()
      属性値がインスタンスとなるカテゴリの名前を返します。

    • コンストラクタの詳細

      • DocumentName

        public DocumentName​(String documentName,
                    Locale locale)
        指定されたドキュメントの名前とロケールで、新しいドキュメントの名前属性を構築します。
        パラメータ:
        documentName - 文書名
        locale - テキスト文字列の自然言語。nullは、Locale.getDefault()によって返されるデフォルトのロケールを意味すると解釈されます。
        例外:
        NullPointerException - documentNameがnullの場合

    • メソッドの詳細

      • equals

        public boolean equals​(Object object)
        このドキュメントの名前属性がオブジェクトに渡された属性と等しいかどうかを返します。 次の条件がすべてtrueの場合に同等とみなされます。
        1. objectはnullではありません。
        2. objectはDocumentNameクラスのインスタンスです。
        3. このドキュメントの名前属性の基になる文字列とobjectの基になる文字列が同じである。
        4. このドキュメントの名前属性のロケールとobjectのロケールが同じである。
        オーバーライド:
        equals、クラス: TextSyntax
        パラメータ:
        object - 比較するObject
        戻り値:
        true objectがこの文書名属性に相当する場合はfalse、それ以外の場合はfalse
        関連項目:
        Object.hashCode()、HashMap

      • getCategory

        public final Class<? extends Attribute> getCategory()
        この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。

        クラスDocumentNameの場合、カテゴリはクラスDocumentName自体です。

        定義:
        getCategory、インタフェース: Attribute
        戻り値:
        印刷属性クラス(category)、クラスjava.lang.Classのインスタンス

      • getName

        public final String getName()
        属性値がインスタンスとなるカテゴリの名前を返します。

        クラスDocumentNameの場合、カテゴリ名は"document-name"です。

        定義:
        getName、インタフェース: Attribute
        戻り値:
        属性カテゴリ名