com.JRcServer.sys.log.custom.base
クラス LogFormatObj

java.lang.Object
  com.JRcServer.sys.log.custom.base.LogFormatObj

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

LogFormat

public class LogFormatObj
extends java.lang.Object
implements LogFormat

ログ出力フォーマット実装.

ログ出力用フォーマットを定義した実装を行います.
ログフォーマットのサンプルとして、以下のような定義が存在します.

"{%s*},{%d10},${%c}"

この場合、左から以下のような解析結果となります.
{%s*} : 文字列型での出力、出力情報文字数[Binary]は、対象値にあわせる.
{%d10} : 数値型での出力、出力情報桁は１０桁（未満の場合、０埋め）.
{%c} : キャラクタ型での出力、１文字のキャラクタ情報を出力.
上記のような定義となります.

導入されたバージョン:

JDK 1.4

バージョン:

1.00, 2003/10/29

作成者:

Masahito Suzuki

フィールドの概要

インタフェース com.JRcServer.sys.log.custom.common.LogFormat から継承されたフィールド

FORMAT_UNKNOWN, OUT_LENGTH_TO_NOTHING, PATTERN_PARAMETER, PATTERN_PAUSE, TYPE_BYTE, TYPE_CALENDAR, TYPE_CHARACTER, TYPE_DATE, TYPE_DATETIME, TYPE_INT, TYPE_LONG, TYPE_MASK, TYPE_SHORT, TYPE_STRING

コンストラクタの概要

LogFormatObj()
コンストラクタ.

LogFormatObj(java.lang.String format)
フォーマット設定.

メソッドの概要

void	clear() 情報クリア.
void	create(java.lang.String format) フォーマット設定.
java.lang.String	getFormat() 設定フォーマット情報の取得.
int	getFormatPattern(int no) フォーマットデータ並びの取得.
int	getFormatPatternLength() フォーマットデータ並び順の個数を取得.
int	getParam(int no) パラメータ属性の取得.
int	getParameterLength() パラメータ数取得.
int	getParamToOutLength(int no) パラメータ属性での、出力情報数の取得.
java.lang.String	getPause(int no) 区切り情報の取得.
int	getPauseLength() 区切り情報数取得.
boolean	isCreate() 情報が生成されているかチェック.

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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

LogFormatObj

public LogFormatObj()

コンストラクタ.

LogFormatObj

public LogFormatObj(java.lang.String format)
             throws InputException,
                    ReadSyntaxException

フォーマット設定.

対象のフォーマット情報を設定します. この情報は、対象のフォーマットパターンに則って処理します.

パラメータ:

format - 対象のフォーマットデータを設定します.

例外:

InputException - 入力例外.

ReadSyntaxException - 読み込み構文例外.

メソッドの詳細

create

public final void create(java.lang.String format)
                  throws InputException,
                         ReadSyntaxException

フォーマット設定.

対象のフォーマット情報を設定します. この情報は、対象のフォーマットパターンに則って処理します.

定義:

インタフェース LogFormat 内の create

パラメータ:

format - 対象のフォーマットデータを設定します.

例外:

InputException - 入力例外.

ReadSyntaxException - 読み込み構文例外.

clear

public final void clear()

情報クリア.

格納されている情報をクリアします.

定義:

インタフェース LogFormat 内の clear

getParam

public final int getParam(int no)
                   throws InputException

パラメータ属性の取得.

パラメータ属性の情報を取得します.

定義:

インタフェース LogFormat 内の getParam

パラメータ:

no - 取得対象の項番を指定します.

戻り値:

int パラメータ属性が返されます.

例外:

InputException - 入力例外.

getParamToOutLength

public final int getParamToOutLength(int no)
                              throws InputException

パラメータ属性での、出力情報数の取得.

パラメータ属性の取得情報数を取得します.

定義:

インタフェース LogFormat 内の getParamToOutLength

パラメータ:

no - 取得対象の項番を指定します.

戻り値:

int パラメータに対する出力最大長が返されます.
[LogFormat.OUT_LENGTH_TO_NOTHING]が返された場合、 出力情報数は特に指定されていません.

例外:

InputException - 入力例外.

getPause

public final java.lang.String getPause(int no)
                                throws InputException

区切り情報の取得.

区切り情報を取得します.

定義:

インタフェース LogFormat 内の getPause

パラメータ:

no - 取得対象の項番を指定します.

戻り値:

String 区切り情報が返されます.

例外:

InputException - 入力例外.

getParameterLength

public final int getParameterLength()

パラメータ数取得.

フォーマット内のパラメータ数を取得します.

定義:

インタフェース LogFormat 内の getParameterLength

戻り値:

int パラメータ数が返されます.
情報が生成されていない場合[-1]が返されます.

getPauseLength

public final int getPauseLength()

区切り情報数取得.

出力対象のパラメータ情報を区切る情報数を取得します.

定義:

インタフェース LogFormat 内の getPauseLength

戻り値:

int 区切り情報数が返されます.
情報が生成されていない場合[-1]が返されます.

getFormatPattern

public final int getFormatPattern(int no)
                           throws InputException

フォーマットデータ並びの取得.

フォーマットデータ並びを取得します.

定義:

インタフェース LogFormat 内の getFormatPattern

パラメータ:

no - 取得対象のデータ並び順の項番を指定します.

戻り値:

int フォーマット並び順が返されます.
[LogFormat#PATTERN_PARAMETER]が返された場合、 対象情報はパラメータ情報です.
[LogFormat#PATTERN_PAUSE]が返された場合、 対象情報は区切り情報です.

例外:

InputException - 入力例外.

getFormatPatternLength

public final int getFormatPatternLength()

フォーマットデータ並び順の個数を取得.

フォーマットデータ並び順の個数を取得します.

定義:

インタフェース LogFormat 内の getFormatPatternLength

戻り値:

int フォーマットデータ並び順が返されます.

getFormat

public final java.lang.String getFormat()

設定フォーマット情報の取得.

設定されているフォーマット情報が返されます.

定義:

インタフェース LogFormat 内の getFormat

戻り値:

String フォーマット情報が返されます.
情報が生成されていない場合[null]が返されます.

isCreate

public final boolean isCreate()

情報が生成されているかチェック.

情報が生成されているかチェックします.

定義:

インタフェース LogFormat 内の isCreate

戻り値:

boolean チェック結果が返されます.
[true]が返された場合、情報は生成されています.
[false]が返された場合、情報は生成されていません.