javax.print.attribute.standard

クラスPrinterName

java.lang.Object

javax.print.attribute.TextSyntax

javax.print.attribute.standard.PrinterName

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

Serializable, Cloneable, Attribute, PrintServiceAttribute

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<? extends Attribute>	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のロケールが同じである。

オーバーライド:

equals、クラス: TextSyntax

パラメータ:

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

戻り値:

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

関連項目:

Object.hashCode()、HashMap

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

getCategory、インタフェース: Attribute

戻り値:

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

getName

public final String getName()

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

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

定義:

getName、インタフェース: Attribute

戻り値:

属性カテゴリの名前