クラス FacesMessage
- java.lang.ObjectSE
-
- jakarta.faces.application.FacesMessage
- 実装済みのインターフェース一覧:
SerializableSE
public class FacesMessage extends ObjectSE implements SerializableSE
FacesMessage は単一の検証(またはその他の)メッセージを表します。これは通常、ビュー内の特定のコンポーネントに関連付けられています。
FacesMessageインスタンスは、特定のmessageIdに基づいて作成できます。この仕様では、FacesMessageインスタンスが必要なmessageIdのセットを定義しています。messageIdを指定してFacesMessageインスタンスを作成する場合、実装は次の手順を実行する必要があります。Application.getMessageBundle()を呼び出します。null以外の場合は、現在のUIViewRootのLocaleを使用して名前付きResourceBundleを見つけ、引数messageIdの値があるかどうかを確認します。存在する場合、値をFacesMessageのsummaryとして扱います。そうでない場合、またはApplication.getMessageBundle()がnullを返した場合は、定数FACES_MESSAGESの値で指定されたResourceBundleを調べ、引数messageIdの値があるかどうかを確認します。存在する場合、値をFacesMessageのsummaryとして扱います。そうでない場合、FacesMessageインスタンスの初期化情報はありません。すべての場合において、
{messageId}に対してResourceBundleヒットが見つかった場合は、キー{messageId}_detailでさらにヒットを探します。この値が存在する場合は、返されるFacesMessageのdetailとして使用します。FacesMessageのsummaryおよびdetailに必要なパラメーター置換を必ず実行してください。- 関連事項:
- 連載形式
ネストされたクラスの概要
ネストされたクラス 修飾子と型 クラス 説明 static classFacesMessage.Severity型保証された列挙でメッセージの重大度レベルを表すために使用されるクラス。
フィールド概要
フィールド 修飾子と型 フィールド 説明 static StringSEFACES_MESSAGESメッセージ識別子が Jakarta Faces 仕様で定義されているメッセージのResourceBundle識別子。static FacesMessage.SeveritySEVERITY_ERRORエラーが発生したことを示すメッセージ重大度レベル。static FacesMessage.SeveritySEVERITY_FATAL重大なエラーが発生したことを示すメッセージの重大度レベル。static FacesMessage.SeveritySEVERITY_INFOエラーではなく情報メッセージを示すメッセージ重大度レベル。static FacesMessage.SeveritySEVERITY_WARNエラーが発生した可能性があることを示すメッセージ重大度レベル。static ListSEVALUES順序値の昇順での、有効なFacesMessage.Severityインスタンスの不変のList。static MapSEVALUES_MAP名前でキー付けされた有効なFacesMessage.Severityインスタンスの不変のMap。
コンストラクター概要
コンストラクター コンストラクター 説明 FacesMessage()初期値なしで新しいFacesMessageを構築します。FacesMessage(FacesMessage.Severity severity, StringSE summary, StringSE detail)指定された初期値で新しいFacesMessageを構築します。FacesMessage(StringSE summary)要約だけで新しいFacesMessageを作成します。FacesMessage(StringSE summary, StringSE detail)指定された初期値で新しいFacesMessageを構築します。
方法の概要
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 StringSEgetDetail()ローカライズされた詳細テキストを返します。FacesMessage.SeveritygetSeverity()重大度レベルを返します。StringSEgetSummary()ローカライズされた要約テキストを返します。booleanisRendered()voidrendered()このメッセージをクライアントにレンダリングされたものとしてマークします。voidsetDetail(StringSE detail)ローカライズされた詳細テキストを設定します。voidsetSeverity(FacesMessage.Severity severity)重大度を設定します。voidsetSummary(StringSE summary)ローカライズされた要約テキストを設定します。
フィールドの詳細
FACES_MESSAGES
public static final StringSE FACES_MESSAGES
メッセージ識別子が Jakarta Faces 仕様で定義されているメッセージの
ResourceBundle識別子。- 関連事項:
- 定数フィールド値
SEVERITY_INFO
public static final FacesMessage.Severity SEVERITY_INFO
エラーではなく情報メッセージを示すメッセージ重大度レベル。
SEVERITY_WARN
public static final FacesMessage.Severity SEVERITY_WARN
エラーが発生した可能性があることを示すメッセージ重大度レベル。
SEVERITY_ERROR
public static final FacesMessage.Severity SEVERITY_ERROR
エラーが発生したことを示すメッセージ重大度レベル。
SEVERITY_FATAL
public static final FacesMessage.Severity SEVERITY_FATAL
重大なエラーが発生したことを示すメッセージの重大度レベル。
VALUES
public static final ListSE VALUES
順序値の昇順での、有効な
FacesMessage.Severityインスタンスの不変のList。
VALUES_MAP
public static final MapSE VALUES_MAP
名前でキー付けされた有効な
FacesMessage.Severityインスタンスの不変のMap。
コンストラクターの詳細
FacesMessage
public FacesMessage()
初期値なしで新しい
FacesMessageを構築します。重大度は Severity.INFO に設定されます。
FacesMessage
public FacesMessage(StringSE summary)
要約だけで新しい
FacesMessageを作成します。詳細はnullで、重大度はSeverity.INFOに設定されています。- パラメーター:
summary- サマリー。
FacesMessage
public FacesMessage(StringSE summary, StringSE detail)
指定された初期値で新しい
FacesMessageを作成します。重大度は Severity.INFO に設定されます。- パラメーター:
summary- ローカライズされた要約メッセージテキストdetail- ローカライズされた詳細メッセージテキスト- 例外:
IllegalArgumentExceptionSE- 指定された重大度レベルがサポートされている値の 1 つではない場合
FacesMessage
public FacesMessage(FacesMessage.Severity severity, StringSE summary, StringSE detail)
指定された初期値で新しい
FacesMessageを構築します。- パラメーター:
severity- 重大度summary- ローカライズされた要約メッセージテキストdetail- ローカライズされた詳細メッセージテキスト- 例外:
IllegalArgumentExceptionSE- 指定された重大度レベルがサポートされている値の 1 つではない場合
メソッドの詳細
getDetail
public StringSE getDetail()
ローカライズされた詳細テキストを返します。このメッセージにローカライズされた詳細テキストが定義されていない場合は、代わりにローカライズされた要約テキストを返します。
- 戻り値:
- ローカライズされた詳細テキスト。
setDetail
public void setDetail(StringSE detail)
ローカライズされた詳細テキストを設定します。
- パラメーター:
detail- 新しいローカライズされた詳細テキスト
getSeverity
public FacesMessage.Severity getSeverity()
重大度レベルを返します。
- 戻り値:
- 重大度レベル。
setSeverity
public void setSeverity(FacesMessage.Severity severity)
重大度を設定します。
- パラメーター:
severity- 新しい重大度レベル- 例外:
IllegalArgumentExceptionSE- 指定された重大度レベルがサポートされている値の 1 つではない場合
getSummary
public StringSE getSummary()
ローカライズされた要約テキストを返します。
- 戻り値:
- ローカライズされた要約テキスト。
setSummary
public void setSummary(StringSE summary)
ローカライズされた要約テキストを設定します。
- パラメーター:
summary- 新しいローカライズされた要約テキスト
isRendered
public boolean isRendered()
- 戻り値:
-
rendered()が呼び出された場合はtrue、それ以外の場合はfalse - 導入:
- 2.0
rendered
public void rendered()
このメッセージをクライアントにレンダリングされたものとしてマークします。
- 導入:
- 2.0