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

クラス ErrorMessage

java.lang.Object

org.opengion.fukurou.util.ErrorMessage

public final class ErrorMessage
extends Object

エラーメッセージを受け渡すときに使用するクラスです。 結果値として、0:正常 1:警告 2:異常 8:EXCEPTION 9:ORACLEエラー を持っています。

変更履歴:

6.5.0.1 (2016/10/21) 連結を、StringBuilder#appendのように、自分自身に出来るように、修正します。

機能分類

エラー処理

導入されたバージョン:

JDK5.0,

フィールドの概要

フィールド

修飾子とタイプ	フィールド	説明
static final int	EXCEPTION	結果値 8:EXCEPTION 8
static final int	NG	結果値 2:異常 2
static final int	OK	結果値 0:正常 0
static final int	ORCL_ERR	結果値 9:ORACLEエラー 9
static final int	WARNING	結果値 1:警告 1

コンストラクタの概要

コンストラクタ

コンストラクタ	説明
ErrorMessage()	デフォルトコンストラクター 詳細メッセージを指定しないで ErrorMessage を構築します。
ErrorMessage(String title)	タイトルを指定して ErrorMessage を構築します。

メソッドの概要

修飾子とタイプ	メソッド	説明
ErrorMessage	addMessage(int no, int kekka, String id, String... args)	指定されたエラー情報を追加登録します。
ErrorMessage	addMessage(String... args)	指定されたエラー情報を追加登録します。
ErrorMessage	addMessage(Throwable th)	指定されたThrowableオブジェクトを元に、エラー情報を追加登録します。
ErrorMessage	addMessage(Throwable th, boolean isST)	指定されたThrowableオブジェクトを元に、エラー情報を追加登録します。
ErrorMessage	addMessage(ErrMsg msg)	指定されたエラーオブジェクトを追加登録します。
ErrorMessage	append(int no, ErrorMessage msg)	指定された ErrorMessageオブジェクトを行番号指定で追加登録します。
ErrorMessage	append(ErrorMessage msg)	指定された ErrorMessageオブジェクトを追加登録します。
int	getKekka()	このエラーメッセージの中で、最大の結果値(エラーの最大レベル)を返します。
String	getTitle()	タイトルを返します。
boolean	isOK()	すべてのメッセージが 正常(OK)かを返します。
boolean	isSetPgStep()	配列中にPG名またはステップ名が設定されているかを返します。
void	setTitle(String title)	タイトルをセットします。
int	size()	リスト内のキーと値のマッピングの数を返します。
ErrMsg[]	toArray()	このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。
String	toString()	メッセージの連結リストを返します。

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

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

フィールド詳細

OK

public static final int OK

結果値 0:正常 0

関連項目:

• 定数フィールド値

WARNING

public static final int WARNING

結果値 1:警告 1

関連項目:

• 定数フィールド値

NG

public static final int NG

結果値 2:異常 2

関連項目:

• 定数フィールド値

EXCEPTION

public static final int EXCEPTION

結果値 8:EXCEPTION 8

関連項目:

• 定数フィールド値

ORCL_ERR

public static final int ORCL_ERR

結果値 9:ORACLEエラー 9

関連項目:

• 定数フィールド値

コンストラクタの詳細

ErrorMessage

public ErrorMessage()

デフォルトコンストラクター 詳細メッセージを指定しないで ErrorMessage を構築します。 (明示しないと、引き通付きコンストラクタのみのクラスになってしまいます。)

ErrorMessage

public ErrorMessage(String title)

タイトルを指定して ErrorMessage を構築します。

パラメータ:

title - タイトル

メソッドの詳細

addMessage

public ErrorMessage addMessage(String... args)

指定されたエラー情報を追加登録します。 これは、行番号０、結果：NG IDは無し(ゼロ文字列)です。 引数の メッセージ が null の場合は、何もしません。

パラメータ:

args - String... メッセージの引数(可変引数)

戻り値:

自分自身

変更履歴:

6.5.0.1 (2016/10/21) 連結を、StringBuilder#appendのように、自分自身に出来るように、修正します。, 6.9.0.0 (2018/01/31) null引数の場合は、NGも登録せず、スルーします。

addMessage

public ErrorMessage addMessage(int no,
 int kekka,
 String id,
 String... args)

指定されたエラー情報を追加登録します。 ただし、id が null の場合は、登録しません。

パラメータ:

no - 行番号

kekka - 結果 0:正常 1:警告 2:異常

id - メッセージID

args - String... メッセージの引数(可変引数)

戻り値:

自分自身

変更履歴:

6.5.0.1 (2016/10/21) 連結を、StringBuilder#appendのように、自分自身に出来るように、修正します。

addMessage

public ErrorMessage addMessage(Throwable th)

指定されたThrowableオブジェクトを元に、エラー情報を追加登録します。 この処理が、一番最初の場合は、行番号０、IDは無し(ゼロ文字列)です。 結果は、NG で登録します。 ここでは、最後に登録された ErrMsg を元に、行番号、id をコピーして使用します。 引数の Throwableオブジェクト が null の場合は、何もしません。

パラメータ:

th - printStackTraceすべき元のThrowableオブジェクト

戻り値:

自分自身

関連項目:

• addMessage(Throwable,boolean)

変更履歴:

6.5.0.1 (2016/10/21) 新規追加, 6.9.0.0 (2018/01/31) null引数の場合は、NGも登録せず、スルーします。, 6.9.2.1 (2018/03/12) スタックトレース情報の処理方法を変更

addMessage

public ErrorMessage addMessage(Throwable th,
 boolean isST)

指定されたThrowableオブジェクトを元に、エラー情報を追加登録します。 isST 引数により、スタックトレース情報を利用するかどうか指定できます。 結果は、NG で登録します。 この処理が、一番最初の場合は、行番号０、IDは無し(ゼロ文字列)です。 ここでは、最後に登録された ErrMsg を元に、行番号、id をコピーして使用します。 引数の Throwableオブジェクト が null の場合は、何もしません。

パラメータ:

th - printStackTraceすべき元のThrowableオブジェクト

isST - スタックトレース情報を使用するかどうか。

戻り値:

自分自身

関連項目:

• ThrowUtil.ogStackTrace(Throwable)
• ThrowUtil.ogThrowMsg(String,Throwable)

変更履歴:

6.5.0.1 (2016/10/21) 新規追加, 6.9.0.0 (2018/01/31) null引数の場合は、NGも登録せず、スルーします。, 6.9.2.1 (2018/03/12) スタックトレース情報の処理方法を変更

addMessage

public ErrorMessage addMessage(ErrMsg msg)

指定されたエラーオブジェクトを追加登録します。 追加するErrMsgが、内部の結果値より大きい場合は、その結果値にセットします。 つまり、内部結果値は、登録されたすべてのエラーオブジェクトの最大値です。 引数の ErrMsgオブジェクト が null の場合は、何もしません。

パラメータ:

msg - エラーオブジェクト

戻り値:

自分自身

変更履歴:

6.5.0.1 (2016/10/21) 連結を、StringBuilder#appendのように、自分自身に出来るように、修正します。, 6.9.0.0 (2018/01/31) null引数の場合は、NGも登録せず、スルーします。

append

public ErrorMessage append(ErrorMessage msg)

指定された ErrorMessageオブジェクトを追加登録します。 タイトルは元のまま変わりません。 現状の ErrorMessage の続きに、追加していきます。 引数の ErrorMessageオブジェクト が null の場合は、何もしません。

パラメータ:

msg - ErrorMessageオブジェクト

戻り値:

自分自身

変更履歴:

6.5.0.1 (2016/10/21) 連結を、StringBuilder#appendのように、自分自身に出来るように、修正します。

append

public ErrorMessage append(int no,
 ErrorMessage msg)

指定された ErrorMessageオブジェクトを行番号指定で追加登録します。 タイトルは元のまま変わりません。 現状の ErrorMessage の続きに、追加していきます。 引数の ErrorMessageオブジェクト が null の場合は、何もしません。

パラメータ:

no - 行番号

msg - ErrorMessageオブジェクト

戻り値:

自分自身

変更履歴:

6.5.0.1 (2016/10/21) 連結を、StringBuilder#appendのように、自分自身に出来るように、修正します。

toArray

public ErrMsg[] toArray()

このリスト内の要素を適切な順序で繰り返し処理する反復子を返します。

戻り値:

すべての要素を正しい順序で保持するErrMsg配列

変更履歴:

4.0.0.0 (2004/12/31) 新規追加, 4.3.2.0 (2008/09/11) private ⇒ public に変更。

このﾒｿｯﾄﾞは、nullを返しません

size

public int size()

リスト内のキーと値のマッピングの数を返します。

戻り値:

リスト内の size

getTitle

public String getTitle()

タイトルを返します。

戻り値:

タイトル

setTitle

public void setTitle(String title)

タイトルをセットします。

パラメータ:

title - タイトル

getKekka

public int getKekka()

このエラーメッセージの中で、最大の結果値(エラーの最大レベル)を返します。

戻り値:

結果 OK, WARNING, NG, ORCL_ERR

isOK

public boolean isOK()

すべてのメッセージが 正常(OK)かを返します。

戻り値:

結果 すべてOK：true / それ以外 false

isSetPgStep

public boolean isSetPgStep()

配列中にPG名またはステップ名が設定されているかを返します。

戻り値:

PG名またはステップ名が設定されているか

変更履歴:

3.8.9.5 (2007/09/12) 新規作成

toString

public String toString()

メッセージの連結リストを返します。

オーバーライド:

toString クラス内 Object

戻り値:

メッセージの連結リスト

このﾒｿｯﾄﾞは、nullを返しません