パッケージ org.opengion.fukurou.fileexec

# クラス MsgUtil

java.lang.Object
org.opengion.fukurou.fileexec.MsgUtil

public final class MsgUtil extends Object
MsgUtilは、共通的に使用されるリソースからメッセージを作成する、ユーティリティークラスです。

     現状は、"org.opengion.fukurou" 以下の message.properties ファイルをリソースとして使用します。
     このリソースファイルを、各言語別に作成することで、アプリケーションのメッセージを国際化できます。
     通常のリソース変換以外に、キーワードと引数で、RuntimeException を返す簡易メソッドも提供します。

変更履歴:
  7.0.0.0 (2017/07/07) 新規作成
導入されたバージョン:
  JDK1.8,

- ## フィールドの概要

  フィールド
  修飾子とタイプ
  フィールド
  説明
  `static final String`
  `OMIT_BASE`
  初期設定されているｸﾗｽ名のｷｰﾜｰﾄﾞ "org.opengion.fukurou"

- ## メソッドの概要

  修飾子とタイプ
  メソッド
  説明
  `static String`
  `errPrintln(String id, Object... args)`
  エラーメッセージを作成して、文字列を返します。
  `static String`
  `errPrintln(Throwable th, String id, Object... args)`
  Throwable付きのエラーメッセージを作成して、LOGGER で出力します。
  `static String`
  `getMsg(String id, Object... args)`
  リソースから取得するメッセージを文字列で返します。
  `static void`
  `setResourceKey(String key)`
  ﾘｿｰｽの取得元のﾍﾞｰｽとなるﾊﾟｯｹｰｼﾞ文字列を指定します。
  `static RuntimeException`
  `throwException(String id, Object... args)`
  メッセージを作成して、RuntimeExceptionの引数にセットして、throw します。
  `static RuntimeException`
  `throwException(Throwable th, String id, Object... args)`
  メッセージを作成して、RuntimeExceptionの引数にセットして、throw します。

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

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

- ## フィールド詳細

  - ### 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) ネットワークパスのチェックを行います。