org.opengion.fukurou.system

## クラス OgRuntimeException

- java.lang.Object
- - java.lang.Throwable
  - - java.lang.Exception
    - - java.lang.RuntimeException
      - - org.opengion.fukurou.system.OgRuntimeException

- すべての実装されたインタフェース:
    Serializable
  直系の既知のサブクラス:
    HybsOverflowException, HybsSystemException, OgCharacterException

      public class OgRuntimeException
      extends RuntimeException

       共通的に使用されるRuntimeExceptionクラスです。

       RuntimeException を継承しているため、try{} catch() {} は不要です。
       本システムでは、すべてこのエクセプションクラスを継承させたクラスを作成し、用途によって、
       使い分けるようにします。つまり、他のどのような、Throwable が発生したとしても、一旦、
       try{} catch() {} で受けて、このクラスのサブクラスを、再度 throw させます。
       そして、必要であれば、try{} catch() {} を用いて捕まえて、それぞれの対応処理を行います。

       このクラスには、元々の発生したエクセプション( Throwable )を引数にとり、
       その printStackTrace()情報を、自分自身のトレース情報に含めます。
       また、引数にオブジェクトを渡すことができますので、object.toString() で、オブジェクトの
       状態を表示できるようにしておけば、手軽にデバッグに使うことが可能になります。

       このRuntimeExceptionを使うと、ThrowUtil#ogStackTrace(String,Throwable) に準拠した
       StackTrace を作成します。これは、最初の３行＋org.opengionを含む行だけのエラーを出力
       しますので、エラーログの容量を大幅に抑えることが可能です。

  関連項目:
    直列化された形式
  変更履歴:

    6.4.2.0 (2016/01/29) 新規作成

  機能分類
    エラー処理
  バージョン
    6.0
  作成者
    Kazuhiko Hasegawa
  導入されたバージョン:
    JDK8.0,

- - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `OgRuntimeException()` 詳細メッセージを指定しないで OgRuntimeException を構築します。
    `OgRuntimeException(String msg)` 指定された詳細メッセージを持つ OgRuntimeException を構築します。
    `OgRuntimeException(String msg, Throwable th)` 指定された詳細メッセージと、Throwableオブジェクトを持つ OgRuntimeException を構築します。
    `OgRuntimeException(Throwable th)` 指定されたThrowableオブジェクトを持つ OgRuntimeException を構築します。

  - ### メソッドのサマリー

    すべてのメソッド インスタンス・メソッド concreteメソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `void` | `addMessage(String msg)` 指定された追加メッセージを、printStackTrace() 出力時に、合成します。
    `void` | `printStackTrace()` このスロー可能オブジェクトおよびそのバックトレースを標準エラー・ストリームに出力します。
    `void` | `printStackTrace(PrintStream ps)` このスロー可能オブジェクトとそのバックトレースを指定された印刷ストリームに出力します。
    `void` | `printStackTrace(PrintWriter pw)` このスロー可能オブジェクトとそのバックトレースを指定されたプリント・ライターに出力します。

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

      `addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, setStackTrace, toString`

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

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

- - ### コンストラクタの詳細

    - #### OgRuntimeException

          public OgRuntimeException()

      詳細メッセージを指定しないで OgRuntimeException を構築します。
      関連項目:
        `RuntimeException.RuntimeException()`
      変更履歴:

        6.4.2.0 (2016/01/29) 新規作成。

    - #### OgRuntimeException

          public OgRuntimeException(String msg)

      指定された詳細メッセージを持つ OgRuntimeException を構築します。
      パラメータ:
        `msg` - 詳細メッセージ
      関連項目:
        `RuntimeException.RuntimeException(String)`
      変更履歴:

        6.4.2.0 (2016/01/29) 新規作成。

    - #### OgRuntimeException

          public OgRuntimeException(Throwable th)

      指定されたThrowableオブジェクトを持つ OgRuntimeException を構築します。
      パラメータ:
        `th` - 例外Throwableオブジェクト
      関連項目:
        `RuntimeException.RuntimeException(Throwable)`
      変更履歴:

        6.4.2.0 (2016/01/29) 新規作成。

    - #### OgRuntimeException

          public OgRuntimeException(String msg,
                                    Throwable th)

      指定された詳細メッセージと、Throwableオブジェクトを持つ OgRuntimeException を構築します。
      パラメータ:
        `msg` - 詳細メッセージ
        `th` - 例外Throwableオブジェクト
      関連項目:
        `RuntimeException.RuntimeException(String,Throwable)`
      変更履歴:

        6.4.2.0 (2016/01/29) 新規作成。

  - ### メソッドの詳細

    - #### addMessage

          public void addMessage(String msg)

      指定された追加メッセージを、printStackTrace() 出力時に、合成します。 主に、openGionバージョンや、その他追記したいメッセージを登録することで、 printStackTrace() 出力時に、合成できます。 複数のメッセージは登録できません。最後に登録したメッセージのみ使用されます。 なお、null のメッセージは登録できません。
      パラメータ:
        `msg` - 追加メッセージ
      変更履歴:

        6.4.2.0 (2016/01/29) 新規作成。

    - #### printStackTrace

          public void printStackTrace()

      このスロー可能オブジェクトおよびそのバックトレースを標準エラー・ストリームに出力します。 ここのメソッドは、このThrowableオブジェクトのスタック・トレースを、System.errフィールドの 値であるエラー出力ストリームで出力します。出力の先頭行には、このオブジェクトに対する toString()メソッドの結果が含まれます。 残りの行は、以前にfillInStackTrace()メソッドによって記録されたデータを表します。 この情報の書式は実装によって異なりますが、典型的な書式の例を次に示します。
      オーバーライド:
        `printStackTrace` クラス内 `Throwable`
      関連項目:
        `Throwable.printStackTrace()`
      変更履歴:

        6.4.2.0 (2016/01/29) 新規作成。

    - #### printStackTrace

          public void printStackTrace(PrintStream ps)

      このスロー可能オブジェクトとそのバックトレースを指定された印刷ストリームに出力します。
      オーバーライド:
        `printStackTrace` クラス内 `Throwable`
      パラメータ:
        `ps` - 出力する印刷ストリーム
      関連項目:
        `Throwable.printStackTrace(PrintStream)`
      変更履歴:

        6.4.2.0 (2016/01/29) 新規作成。

    - #### printStackTrace

          public void printStackTrace(PrintWriter pw)

      このスロー可能オブジェクトとそのバックトレースを指定されたプリント・ライターに出力します。
      オーバーライド:
        `printStackTrace` クラス内 `Throwable`
      パラメータ:
        `pw` - 出力するプリント・ライター
      関連項目:
        `Throwable.printStackTrace(PrintWriter)`
      変更履歴:

        6.4.2.0 (2016/01/29) 新規作成。

Webアプリケーションフレームワーク openGion
Copyright (c) 2009 The openGion Project.