org.apache.struts.action
クラス ActionMessages

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

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

java.io.Serializable

直系の既知のサブクラス:

ActionErrors

public class ActionMessages

extends java.lang.Object

implements java.io.Serializable

メッセージをカプセル化したクラスです。 メッセージはグローバル、 または指定どちらかの特別なBeanプロパティとなることができます。

それぞれ特定のメッセージは、 ActionMessageオブジェクトにより記述されます。 このオブジェクトはメッセージキーを含みます。 (メッセージキーは、適切なメッセージリソースデータベースを調べるためです。) そして、 4つまでのプレースホルダー引数が結果のメッセージの置換変数として使用されます。

実装上の注意 - これらのオブジェクトは、 シングルスレッドコンテキストの中でのみ生成され扱われることを想定しています。 従いまして、内部コレクションへのアクセスは同期化されていません。

導入されたバージョン:

Struts 1.1

バージョン:

$Revision: 1.5 $ $Date: 2005/05/09 13:23:57 $

関連項目:

直列化された形式

翻訳者:

棚澤 昌幸

校正者:

入れ子クラスの概要

protected class

ActionMessages.ActionMessageItem プロパティ/キーとリストに最初に追加する位置に関連付けられたメッセージのセットを登録するため、 このクラスは使われます。

フィールドの概要

protected boolean	accessed このオブジェクトに関連付けられたメッセージを持つかのboolean。
private static java.util.Comparator	actionItemComparator アクションメッセージアイテムオブジェクトを比較します。
static java.lang.String	GLOBAL_MESSAGE 特定のプロパティと関連付けられたものとは対照的に、 グローバルメッセージを使用するための"プロパティ名"の文字列。
protected int	iCount 加算されたプロパティ/キーの最新の数値。
protected java.util.HashMap	messages それぞれのプロパティでプロパティ名をキーとした、 (ArrayListに代表される)ActionMessageオブジェクトの累積されたセット。

コンストラクタの概要

ActionMessages()
空のActionMessagesオブジェクトを生成します。

ActionMessages(ActionMessages messages)
与えられたメッセージで初期化されたActionMessagesオブジェクトを生成します。

メソッドの概要

void	add(ActionMessages messages) このメッセージのセットに与えられたActionMessagesオブジェクトからメッセージを追加します。
void	add(java.lang.String property, ActionMessage message) 指定されたプロパティでメッセージのセットにメッセージを追加します。
void	clear() このオブジェクトにより登録されている全てのメッセージを消去します。
java.util.Iterator	get() メッセージに関連付けられたプロパティにより区別することなく、 登録されている全てのメッセージを返します。
java.util.Iterator	get(java.lang.String property) 指定されたプロパティに関連付けられたメッセージのセットを返します。
boolean	isAccessed() get()またはget(String)メソッドが呼ばれている場合、 trueを返します。
boolean	isEmpty() このコレクションにメッセージが登録されていない場合、 trueを返します。
java.util.Iterator	properties() 少なくとも1つ以上登録されているプロパティ名のセットを返します。
int	size() (グローバルメッセージを含む)全てのプロパティに登録されたメッセージの数を返します。
int	size(java.lang.String property) 指定されたプロパティに関連付けられたメッセージの数を返します。
java.lang.String	toString() このアクションメッセージのプロパティ名=メッセージリストのマップを表わす文字列を返します。

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

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

フィールドの詳細

actionItemComparator

private static final java.util.Comparator actionItemComparator

アクションメッセージアイテムオブジェクトを比較します。

GLOBAL_MESSAGE

public static final java.lang.String GLOBAL_MESSAGE

特定のプロパティと関連付けられたものとは対照的に、 グローバルメッセージを使用するための"プロパティ名"の文字列。

関連項目:

定数フィールド値

accessed

protected boolean accessed

このオブジェクトに関連付けられたメッセージを持つかのboolean。

セッションスコープに格納されたメッセージを削除できるか判断するため、 コントローラはこのプロパティを使用します。

導入されたバージョン:

Struts 1.2

messages

protected java.util.HashMap messages

それぞれのプロパティでプロパティ名をキーとした、 (ArrayListに代表される)ActionMessageオブジェクトの累積されたセット。

iCount

protected int iCount

加算されたプロパティ/キーの最新の数値。 この値は加えられたメッセージの順序を維持するために使用されます。

コンストラクタの詳細

ActionMessages

public ActionMessages()

空のActionMessagesオブジェクトを生成します。

ActionMessages

public ActionMessages(ActionMessages messages)

与えられたメッセージで初期化されたActionMessagesオブジェクトを生成します。

パラメータ:

messages - このオブジェクトに最初に加えられるメッセージ このパラメータはnullも可能です。

導入されたバージョン:

Struts 1.1

メソッドの詳細

add

public void add(java.lang.String property,
                ActionMessage message)

指定されたプロパティでメッセージのセットにメッセージを追加します。 プロパティ/キーの最初に加えられた内容を基に、 プロパティ/キーの順序は維持されます。

パラメータ:

property - プロパティ名(またはActionMessages.GLOBAL_MESSAGE)

message - 追加するメッセージ

add

public void add(ActionMessages messages)

このメッセージのセットに与えられたActionMessagesオブジェクトからメッセージを追加します。 メッセージはpropertiesメソッドで返された順序の中に追加されます。 メッセージのプロパティが最新のActionMessagesオブジェクト既に存在する場合、 プロパティのためのリストの最後に追加されます。 メッセージのプロパティが最新のリストに無い場合、 プロパティの最後に追加されます。

パラメータ:

messages - 追加されるActionMessagesオブジェクト このパラメータはnullも可能です。

導入されたバージョン:

Struts 1.1

clear

public void clear()

このオブジェクトにより登録されている全てのメッセージを消去します。

isEmpty

public boolean isEmpty()

このコレクションにメッセージが登録されていない場合、 trueを返します。 それ以外の場合、 falseを返します。

導入されたバージョン:

Struts 1.1

get

public java.util.Iterator get()

メッセージに関連付けられたプロパティにより区別することなく、 登録されている全てのメッセージを返します。 メッセージが登録されたいない場合、 空のリストを返します。

get

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

指定されたプロパティに関連付けられたメッセージのセットを返します。 そのようなメッセージが無い場合、 空のリストを返します。

パラメータ:

property - プロパティ名(またはActionMessages.GLOBAL_MESSAGE)

isAccessed

public boolean isAccessed()

get()またはget(String)メソッドが呼ばれている場合、 trueを返します。

戻り値:

true メッセージが1回以上アクセスされている場合

導入されたバージョン:

Struts 1.2

properties

public java.util.Iterator properties()

少なくとも1つ以上登録されているプロパティ名のセットを返します。 メッセージが無い場合、 空のIteratorを返します。 グローバルメッセージを登録している場合、 ActionMessages.GLOBAL_MESSAGEのString値が返されるプロパティ名の1つとなります。

size

public int size()

(グローバルメッセージを含む)全てのプロパティに登録されたメッセージの数を返します。 注意 - メッセージの有無に関心がある場合、 isEmptyを使用する方が効果的です。

size

public int size(java.lang.String property)

指定されたプロパティに関連付けられたメッセージの数を返します。

パラメータ:

property - プロパティ名(またはActionMessages.GLOBAL_MESSAGE)

toString

public java.lang.String toString()

このアクションメッセージのプロパティ名=メッセージリストのマップを表わす文字列を返します。

関連項目:

Object.toString()