クラス MsgUtil


  • public final class MsgUtil
    extends Object
    MsgUtilは、共通的に使用されるリソースからメッセージを作成する、ユーティリティークラスです。
     現状は、"org.opengion.fukurou" 以下の message.properties ファイルをリソースとして使用します。
     このリソースファイルを、各言語別に作成することで、アプリケーションのメッセージを国際化できます。
     通常のリソース変換以外に、キーワードと引数で、RuntimeException を返す簡易メソッドも提供します。
    
    
    変更履歴:
    7.0.0.0 (2017/07/07) 新規作成
    バージョン
    7.0
    作成者
    Kazuhiko Hasegawa
    導入されたバージョン:
    JDK1.8,
    • フィールドの詳細

      • OMIT_BASE

        public static final String OMIT_BASE
        初期設定されているクラス名のキーワード "org.opengion.fukurou"
        関連項目:
        定数フィールド値
    • メソッドの詳細

      • setResourceKey

        public static void setResourceKey​(String key)
        リソースの取得元のベースとなるパッケージ文字列を指定します。 リソースは、keyで指定するパッケージの直下に、 "message_ja_JP.properties" 形式のファイルで用意しておきます。
        パラメータ:
        key - リソースのベースとなるパッケージ文字列。
      • getMsg

        public static String getMsg​(String id,
                                    Object... args)
        リソースから取得するメッセージを文字列で返します。 id と引数を受け取り、ResourceBundle と、MessageFormat.format で加工した 文字列を返します。 親リソースとして、"org.opengion.fukurou.message" で定義されたリソースバンドルを 読み込んでいます。
        パラメータ:
        id - リソースのキーとなるID。
        args - リソースを、MessageFormat.format で加工する場合の引数。
        戻り値:
        MessageFormat.formatで加工された文字列
        変更履歴:
        6.4.3.1 (2016/02/12) 新規追加, 6.8.1.5 (2017/09/08) LOGGER.debug 情報の追加, 7.2.5.0 (2020/06/01) ResourceBundleは、native2asciiなしで(ResourceBundle.Controlも不要)使用できる。
      • throwException

        public static RuntimeException throwException​(String id,
                                                      Object... args)
        メッセージを作成して、RuntimeExceptionの引数にセットして、throw します。
        パラメータ:
        id - リソースのキーとなるID。
        args - リソースを、MessageFormat.format で加工する場合の引数。
        戻り値:
        メッセージを書き込んだ、RuntimeException
        関連項目:
        getMsg( String,Object... ), throwException( Throwable,String,Object... )
        変更履歴:
        6.4.3.1 (2016/02/12) 新規追加
      • throwException

        public static RuntimeException throwException​(Throwable th,
                                                      String id,
                                                      Object... args)
        メッセージを作成して、RuntimeExceptionの引数にセットして、throw します。
        パラメータ:
        th - 発生元のThrowable( null値は許容されます )
        id - リソースのキーとなるID。
        args - リソースを、MessageFormat.format で加工する場合の引数。
        戻り値:
        メッセージを書き込んだ、RuntimeException
        関連項目:
        getMsg( String,Object... ), throwException( String,Object... )
        変更履歴:
        6.4.3.1 (2016/02/12) 新規追加, 6.8.1.5 (2017/09/08) LOGGER.debug 情報の追加
      • errPrintln

        public static String errPrintln​(String id,
                                        Object... args)
        エラーメッセージを作成して、文字列を返します。
        パラメータ:
        id - リソースのキーとなるID。
        args - リソースを、MessageFormat.format で加工する場合の引数。
        戻り値:
        作成されたエラーメッセージ文字列
        関連項目:
        getMsg( String,Object... )
        変更履歴:
        6.4.3.1 (2016/02/12) 新規追加
      • errPrintln

        public static String errPrintln​(Throwable th,
                                        String id,
                                        Object... args)
        Throwable付きのエラーメッセージを作成して、LOGGER で出力します。
        パラメータ:
        th - 発生元のThrowable( null値は許容されます )
        id - リソースのキーとなるID。
        args - リソースを、MessageFormat.format で加工する場合の引数。
        戻り値:
        作成されたエラーメッセージ文字列
        関連項目:
        getMsg( String,Object... )
        変更履歴:
        6.4.3.1 (2016/02/12) 新規追加, 7.2.5.0 (2020/06/01) ネットワークパスのチェックを行います。