javax.print.attribute.standard

クラスRequestingUserName

java.lang.Object

javax.print.attribute.TextSyntax

javax.print.attribute.standard.RequestingUserName

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

Serializable, Cloneable, Attribute, PrintRequestAttribute

public final class RequestingUserName
extends TextSyntax
implements PrintRequestAttribute

RequestingUserNameは、印刷ジョブを送信したエンド・ユーザー名を指定するテキスト属性の印刷属性クラスです。印刷要求ユーザー名は、クライアントで定義される任意の文字列です。プリンタではクライアント指定のRequestingUserName属性を印刷ジョブの属性セットには使用せず、JobOriginatingUserName属性を使用します。つまり、この属性によるユーザー名指定をサポートするサービスは、ジョブの属性セットのJobOriginatingUserNameも通知する必要があります。多くの印刷サービスはユーザー名を独自に認証する機能を持ち、印刷要求ユーザー名のサポートが明記されていても、実際にはこの属性で指定されるユーザー名ではなく、サービスで認証されるユーザー名が通知される点に注意してください。

IPP互換性: 文字列の値はIPP名の値を示します。ロケールはIPPの言語を示します。getName()によって返されるカテゴリ名はIPP属性の名前を示します。

関連項目:

直列化された形式

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

コンストラクタ

コンストラクタと説明
RequestingUserName(String userName, 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

コンストラクタの詳細

RequestingUserName

public RequestingUserName(String userName,
                          Locale locale)

指定されたユーザー名とロケールを使用し、新しい印刷要求ユーザー名属性を構築します。

パラメータ:

userName - ユーザー名。

locale - テキスト文字列の言語。nullは、Locale.getDefault()によって返されるデフォルトのロケールを示すと解釈されます

例外:

NullPointerException - 非チェック例外。userNameがnullの場合にスローされます。

メソッドの詳細

equals

public boolean equals(Object object)

この印刷要求ユーザー名属性がオブジェクトで渡されるものと同等かどうかを返します。次の条件がすべてtrueの場合に同等とみなされます。

1. objectがnullではない。
2. objectがRequestingUserNameクラスのインスタンスである。
3. この印刷要求ユーザー名属性の基になる文字列とobjectの基になる文字列が同じである。
4. この印刷要求ユーザー名属性のロケールとobjectのロケールが同じである。

オーバーライド:

equals、クラス: TextSyntax

パラメータ:

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

戻り値:

objectがこの印刷要求ユーザー名属性と一致する場合はtrue、そうでない場合はfalse。

関連項目:

Object.hashCode()、HashMap

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

getCategory、インタフェース: Attribute

戻り値:

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

getName

public final String getName()

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

RequestingUserNameクラスの場合、カテゴリ名は"requesting-user-name"です。

定義:

getName、インタフェース: Attribute

戻り値:

属性カテゴリの名前