jp.co.hitachi.soft.portal.api.util.StringResource

機能

ストリングリソースを取得するクラスです。

使用方法

getStringResourceメソッドでインスタンスを取得して使用してください。

メソッドの一覧

戻り値のデータ型メソッド説明
EnumerationgetKeys()ストリングリソースのキーの一覧を取得します。
StringgetString(String key)ストリングリソースから指定したキーに対する値を取得します。
static final StringResourcegetStringResource(HttpServletRequest req,String appkey)ユーザの使用言語に合わせたストリングリソース(StringResourceクラス)を取得します。
public static final StringResourcegetStringResource(java.util.Locale locale, String appkey)指定した言語に合わせたストリングリソース(StringResourceクラス)を取得します。

メソッドの説明

getKeys
形式

public Enumeration getKeys()

機能
ストリングリソースファイルからメッセージキーの一覧を取得します。メッセージキーが存在しない場合,要素数0の配列を返却します。このメソッドを呼び出す前に,getStringResource()メソッドでインスタンスを取得してください。
パラメタ
なし
戻り値
ストリングリソース内のキー一覧
例外
なし
getString
形式

public String getString(String key)

機能
ストリングリソースファイルからメッセージを取得します。このメソッドを呼び出す前に,getStringResource()メソッドでインスタンスを取得してください。ストリングリソースファイルに該当するメッセージキーが存在しない場合,nullを戻します。
パラメタ
key - メッセージキー(null以外)
戻り値
ストリングリソースファイルから取得したメッセージ
例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合
getStringResource(HttpServletRequest req, String appkey)
形式

public static final StringResource getStringResource(HttpServletRequest req,
                        String appkey)

機能
指定したアプリケーションキー,およびユーザの設定言語に対応するStringResourceクラスのインスタンスを取得します。該当するストリングリソースファイルが存在しない場合,およびデフォルト言語のストリングリソースファイルを検索しても取得できなかった場合,例外(MissingResourceException)が発生します。
パラメタ
req - サーブレットリクエスト(null以外)
appkey - アプリケーションキー(null以外)
戻り値
ストリングリソースクラス
例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合
MissingResourceException - ストリングリソースファイルが見つからない場合
getStringResource(java.util.Locale locale, String appkey)
形式

public static final StringResource
     getStringResource(java.util.Locale locale, String appkey)

機能
指定したアプリケーションキー,およびロケールに対応するStringResourceクラスのインスタンスを取得します。該当するストリングリソースファイルが存在しない場合,およびデフォルト言語のストリングリソースファイルを検索しても取得できなかった場合,例外(MissingResourceException)が発生します。
パラメタ
locale - ロケール(null以外)
appkey - アプリケーションキー(null以外)
戻り値
ストリングリソースクラス
例外
IllegalArgumentException - 入力パラメタがnullまたは不正な場合
MissingResourceException - ストリングリソースファイルが見つからない場合