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 のロケールが等しい

オーバーライド:

クラス TextSyntax 内の equals

パラメータ:

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

戻り値:

object がこの印刷要求ユーザ名属性と同等の場合は true、そうでない場合は false

関連項目:

Object.hashCode(), Hashtable

getCategory

public final Class<? extends Attribute> getCategory()

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

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

定義:

インタフェース Attribute 内の getCategory

戻り値:

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

getName

public final String getName()

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

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

定義:

インタフェース Attribute 内の getName

戻り値:

属性カテゴリの名前