jp.co.fujitsu.reffi.common.exception
クラス AbstractCoreException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          jp.co.fujitsu.reffi.common.exception.AbstractCoreException

すべての実装されたインタフェース:

Serializable, CoreExceptionIF

直系の既知のサブクラス:

CoreLogicException

public abstract class AbstractCoreException
extends Exception
implements CoreExceptionIF

[概 要]

共通例外の抽象基底クラスです.

[詳 細]

このクラスを継承した例外クラスがスローされ、フレームワークに キャッチされると、自動的にユーザ通知が行われます。 ユーザ通知を意図的にしない場合、setNotifyToUser(false)をコールして下さい。

[備 考]

作成者:

Project Reffi

関連項目:

直列化された形式

コンストラクタの概要

AbstractCoreException()

AbstractCoreException(String id)
メッセージIDを引数に取るコンストラクタです。

AbstractCoreException(String id, Throwable e)
メッセージIDと原因例外を引数に取るコンストラクタです。

メソッドの概要

String	getId() [概 要] エラー番号取得 [詳 細] 設定されているエラー番号を取得します。
String	getMessage() [概 要] エラーメッセージ取得 [詳 細] 設定されているエラーメッセージを取得します。
protected abstract String	getMessageSource() メッセージリソースの所在を返却するメソッドです。
protected void	init() 例外初期化メソッドです。
boolean	isNotifyToUser() [概 要] クライアント通知フラグ取得 [詳 細] エラー内容クライアント通知フラグを取得します。
void	setId(String id) [概 要] エラー番号設定 [詳 細] [備 考]
void	setMessage(String message) この例外が保持するエラーメッセージを返却します。
void	setNotifyToUser(boolean notifyToUser) [概 要] クライアント通知フラグ設定 [詳 細] エラー内容クライアント通知フラグを設定します。

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

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

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

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

コンストラクタの詳細

AbstractCoreException

public AbstractCoreException()

AbstractCoreException

public AbstractCoreException(String id)

メッセージIDを引数に取るコンストラクタです。 getMessageSource()で指定したProperties内のキーを指定して下さい。

パラメータ:

id - メッセージID

AbstractCoreException

public AbstractCoreException(String id,
                             Throwable e)

メッセージIDと原因例外を引数に取るコンストラクタです。 既にスローされた例外をキャッチしてCoreExceptionIF実装例外 に包みます。

                try{
                        :
                }catch(IOException e){
                        throw new CoreLogicException("EFC9999", e);
                }
 

上記のように発生した例外に対してメッセージを付けて、 フレームワークにスローすることが出来ます。

パラメータ:

id - メッセージID

e - 原因例外

メソッドの詳細

getMessageSource

protected abstract String getMessageSource()

メッセージリソースの所在を返却するメソッドです。 AbstractCoreExceptionを継承する例外は必ずこのメソッドを実装して、 メッセージ取得元を返却する必要が有ります。 クラスパスの通ったディレクトリにあるpropertiesを以下のようにして 返却して下さい。

        protected String getMessageSource(){
                return "jp.co.fujitsu.reffi.common.exception.corelogic_message";
        }
 

戻り値:

propertiesが存在する名前空間

getId

public String getId()

インタフェース CoreExceptionIF の記述:

[概 要]

エラー番号取得

[詳 細]

設定されているエラー番号を取得します。

[備 考]

定義:

インタフェース CoreExceptionIF 内の getId

戻り値:

エラー番号

setId

public void setId(String id)

[概 要]

エラー番号設定

[詳 細]

[備 考]

パラメータ:

id - エラー番号

getMessage

public String getMessage()

インタフェース CoreExceptionIF の記述:

[概 要]

エラーメッセージ取得

[詳 細]

設定されているエラーメッセージを取得します。

[備 考]

定義:

インタフェース CoreExceptionIF 内の getMessage

オーバーライド:

クラス Throwable 内の getMessage

戻り値:

エラーメッセージ

setMessage

public void setMessage(String message)

この例外が保持するエラーメッセージを返却します。

パラメータ:

エラーメッセージ -

isNotifyToUser

public boolean isNotifyToUser()

インタフェース CoreExceptionIF の記述:

[概 要]

クライアント通知フラグ取得

[詳 細]

エラー内容クライアント通知フラグを取得します。

[備 考]

定義:

インタフェース CoreExceptionIF 内の isNotifyToUser

戻り値:

通知する場合はtrue、それ以外はfalse

setNotifyToUser

public void setNotifyToUser(boolean notifyToUser)

インタフェース CoreExceptionIF の記述:

[概 要]

クライアント通知フラグ設定

[詳 細]

エラー内容クライアント通知フラグを設定します。

[備 考]

定義:

インタフェース CoreExceptionIF 内の setNotifyToUser

パラメータ:

notifyToUser - 通知する場合はtrue、それ以外はfalse

init

protected void init()

例外初期化メソッドです。 getMessageSource()オーバーライドメソッドで返却された Propertiesファイルを読み込みます。