org.apache.struts.action
クラス ActionErrors

java.lang.Object
  org.apache.struts.action.ActionErrors

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

java.io.Serializable

public class ActionErrors

extends java.lang.Object

implements java.io.Serializable

ActionFormのvalidate()メソッドが報告するエラーメッセージをカプセル化するクラスです。 バリデーションエラーはそれらが関連しているActionForm bean全体についてグローバルであるか、 またはあるbeanのプロパティ（すなわち対応するフォームのある入力フィールド）に固有です。

それぞれの個々のエラーは、 （適切なメッセージリソースデータベースを検索するための）メッセージキーと、 メッセージの中のパラメータの置換に用いられる4つまでのプレースホルダー引数を持つActionErrorオブジェクトで記述されます。

実装の際の注意 - これらのオブジェクトはシングルスレッドのコンテキストの中で生成され操作されると仮定しています。 従って、内部のコレクションにアクセスする際に同期化する必要はありません。

作成者:

David Geary, Craig R. McClanahan

関連項目:

直列化された形式

翻訳者:

横田 健彦 [日本語訳のコメントは、report@jajakarta.orgに送ってください。]

フィールドの概要

protected java.util.HashMap	errors プロパティ名をキーとして、 それぞれのプロパティに関して蓄積されたActionErrorオブジェクトの集合（ArrayListとして蓄積）です。
static java.lang.String	GLOBAL_ERROR 特定のプロパティに関連するエラーとは反対に、 グローバルなエラーに用いる「プロパティ名」マーカです。

コンストラクタの概要

ActionErrors()

メソッドの概要

void	add(java.lang.String property, ActionError error) 指定されたプロパティに関して、 エラーの集合にエラーメッセージを追加します。
void	clear() このオブジェクトに記録されている全てのエラーメッセージをクリアします。
boolean	empty() このコレクションにエラーメッセージが記録されていない場合はtrueを返し、 そうでない場合はfalseを返します。
java.util.Iterator	get() どのプロパティに関連づけられているかを区別せずに、 記録されている全てのエラーメッセージの集合を返します。
java.util.Iterator	get(java.lang.String property) 指定されたプロパティに関連づけられているエラーメッセージの集合を返します。
java.util.Iterator	properties() 少なくとも1つのエラーが記録されているプロパティの名前の集合を返します。
int	size() 全てのプロパティ（グローバルエラーを含みます） に記録されているエラーの個数を返します。
int	size(java.lang.String property) 指定されたプロパティに関連づけられているエラーの個数を返します。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

GLOBAL_ERROR

public static final java.lang.String GLOBAL_ERROR

特定のプロパティに関連するエラーとは反対に、 グローバルなエラーに用いる「プロパティ名」マーカです。

関連項目:

定数フィールド値

errors

protected java.util.HashMap errors

プロパティ名をキーとして、 それぞれのプロパティに関して蓄積されたActionErrorオブジェクトの集合（ArrayListとして蓄積）です。

コンストラクタの詳細

ActionErrors

public ActionErrors()

メソッドの詳細

add

public void add(java.lang.String property,
                ActionError error)

指定されたプロパティに関して、 エラーの集合にエラーメッセージを追加します。

パラメータ:

property - プロパティ名（もしくはActionErrors.GLOBAL_ERROR）

error - 追加するエラーメッセージ

clear

public void clear()

このオブジェクトに記録されている全てのエラーメッセージをクリアします。

empty

public boolean empty()

このコレクションにエラーメッセージが記録されていない場合はtrueを返し、 そうでない場合はfalseを返します。

get

public java.util.Iterator get()

どのプロパティに関連づけられているかを区別せずに、 記録されている全てのエラーメッセージの集合を返します。 エラーメッセージが記録されていない場合は空のイテレータを返します。

get

public java.util.Iterator get(java.lang.String property)

指定されたプロパティに関連づけられているエラーメッセージの集合を返します。 エラーメッセージが関連づけられていない場合は、 空のイテレータを返します。

パラメータ:

property - プロパティ名（もしくはActionErrors.GLOBAL_ERROR）

properties

public java.util.Iterator properties()

少なくとも1つのエラーが記録されているプロパティの名前の集合を返します。 エラーが存在しない場合は、空のイテレータを返します。 グローバルエラーが記録されている場合、 ActionErrors.GLOBAL_ERROR の文字列値をプロパティの名前の1つとして返します。

size

public int size()

全てのプロパティ（グローバルエラーを含みます） に記録されているエラーの個数を返します。 注意 - エラーメッセージが存在するかどうかを調べたい場合は empty()を呼び出す方がより効率的です。

size

public int size(java.lang.String property)

指定されたプロパティに関連づけられているエラーの個数を返します。

パラメータ:

property - プロパティ名（もしくはActionErrors.GLOBAL_ERROR）