javax.print.attribute.standard
クラス PrinterName

java.lang.Object
  |
  +--javax.print.attribute.TextSyntax
        |
        +--javax.print.attribute.standard.PrinterName

すべての実装インタフェース:

Attribute, Cloneable, PrintServiceAttribute, Serializable

public final class PrinterName

extends TextSyntax

implements PrintServiceAttribute

PrinterName は、プリンタ名を指定するテキスト属性の印刷属性クラスです。URI よりもユーザにとってわかりやすい名前が使用されます。プリンタ名は管理者が決定し、この属性にそのプリンタ名を設定します。URI の最後の部分を使用することもありますが、まったく関係ない名前の場合もあります。US-English 以外のロケールでは、URI では使用できない文字をこの名前で使用できます。

IPP 互換性: 文字列の値が IPP 名、ロケールが IPP の言語、getName() で返されるカテゴリ名が IPP 属性名にそれぞれ対応します。

関連項目:

直列化された形式

コンストラクタの概要

PrinterName(String printerName, Locale locale)
指定された名前とロケールを使用して、新しいプリンタ名属性を構築します。

メソッドの概要

boolean	equals(Object object) このプリンタ名属性がオブジェクトで渡されるものと一致するかどうかを返します。
Class	getCategory() この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。
String	getName() この属性値がインスタンスであるカテゴリの名称を返します。

クラス javax.print.attribute.TextSyntax から継承したメソッド

getLocale, getValue, hashCode, toString

クラス java.lang.Object から継承したメソッド

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

PrinterName

public PrinterName(String printerName,
                   Locale locale)

指定された名前とロケールを使用して、新しいプリンタ名属性を構築します。

パラメータ:

printerName - プリンタ名

locale - テキスト文字列の言語。null の場合、Locale.getDefault() で返される既定のロケールが使用されます。

例外:

NullPointerException - 未確認の例外。printerName が null の場合

メソッドの詳細

equals

public boolean equals(Object object)

このプリンタ名属性がオブジェクトで渡されるものと一致するかどうかを返します。次の条件がすべて true の場合に一致すると見なされます。

1. object が null でない
2. object が PrinterName クラスのインスタンスである
3. このプリンタ名属性の基底文字列と object の基底文字列が一致する
4. このプリンタ名属性のロケールと object のロケールが一致する

オーバーライド:

クラス TextSyntax 内の equals

パラメータ:

object - 比較対象のオブジェクト

戻り値:

object がこのプリンタ名属性と一致する場合は true、そうでない場合は false

getCategory

public final Class getCategory()

この印刷属性値の「カテゴリ」として使用される印刷属性クラスを返します。

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

定義:

インタフェース Attribute 内の getCategory

戻り値:

java.lang.Class クラスのインスタンスである印刷属性クラス (カテゴリ)

getName

public final String getName()

この属性値がインスタンスであるカテゴリの名称を返します。

PrinterName クラスの場合、カテゴリ名は printer-name になります。

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリ名