com.JRcServer.sys.log.custom.common
インタフェース LogFormat

既知の実装クラスの一覧:
LogFormatObj

public interface LogFormat

ログ出力フォーマット定義.

ログ出力用フォーマットを定義します.

導入されたバージョン:
JDK 1.4
バージョン:
1.00, 2003/10/29
作成者:
Masahito Suzuki

フィールドの概要
static int FORMAT_CHARACTER
          パラメータ属性 : キャラクタ情報.
static int FORMAT_NUMBER
          パラメータ属性 : 数値情報.
static int FORMAT_STRING
          パラメータ属性 : 文字列情報.
static int FORMAT_UNKNOWN
          パラメータ属性 : 不明パラメータ.
static int OUT_LENGTH_TO_NOTHING
          表示桁数指定なし.
static int PATTERN_PARAMETER
          フォーマット配置パターン : パラメータ情報.
static int PATTERN_PAUSE
          フォーマット配置パターン : 区切り情報.
static int TYPE_BYTE
          指定データタイプ : 1バイト数値情報.
static int TYPE_CALENDAR
          指定データタイプ : カレンダデータ情報.
static int TYPE_CHARACTER
          指定データタイプ : キャラクタ情報.
static int TYPE_DATE
          指定データタイプ : 日付データ情報.
static int TYPE_DATETIME
          指定データタイプ : 日付・時間データ情報.
static int TYPE_INT
          指定データタイプ : 4バイト数値情報.
static int TYPE_LONG
          指定データタイプ : 8バイト数値情報.
static int TYPE_MASK
          タイプデータマスク情報.
static int TYPE_SHORT
          指定データタイプ : 2バイト数値情報.
static int TYPE_STRING
          指定データタイプ : 文字列情報.
 
メソッドの概要
 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()
          情報が生成されているかチェック.
 

フィールドの詳細

FORMAT_UNKNOWN

static final int FORMAT_UNKNOWN
パラメータ属性 : 不明パラメータ.

不明なパラメータ属性です.

関連項目:
定数フィールド値

FORMAT_CHARACTER

static final int FORMAT_CHARACTER
パラメータ属性 : キャラクタ情報.

キャラクタのパラメータ属性です. この情報は、キャラクタ(1文字)情報出力に対応した パラメータ属性です.

関連項目:
定数フィールド値

FORMAT_NUMBER

static final int FORMAT_NUMBER
パラメータ属性 : 数値情報.

数値のパラメータ属性です. この情報は、数値情報のみ扱うことが可能なパラメータ属性です.

関連項目:
定数フィールド値

FORMAT_STRING

static final int FORMAT_STRING
パラメータ属性 : 文字列情報.

文字列のパラメータ属性です. この情報は、文字列を扱うことが可能なパラメータ属性です.

関連項目:
定数フィールド値

OUT_LENGTH_TO_NOTHING

static final int OUT_LENGTH_TO_NOTHING
表示桁数指定なし.

表示桁数が指定されていない情報です.

関連項目:
定数フィールド値

PATTERN_PARAMETER

static final int PATTERN_PARAMETER
フォーマット配置パターン : パラメータ情報.

フォーマット配置においてパラメータ情報を意味します.

関連項目:
定数フィールド値

PATTERN_PAUSE

static final int PATTERN_PAUSE
フォーマット配置パターン : 区切り情報.

フォーマット配置において区切り情報を意味します.

関連項目:
定数フィールド値

TYPE_MASK

static final int TYPE_MASK
タイプデータマスク情報.

関連項目:
定数フィールド値

TYPE_CHARACTER

static final int TYPE_CHARACTER
指定データタイプ : キャラクタ情報.

キャラクタ属性の指定データタイプです. この情報は(char[])である場合のタイプを指定します.

関連項目:
定数フィールド値

TYPE_BYTE

static final int TYPE_BYTE
指定データタイプ : 1バイト数値情報.

1バイト数値属性の指定データタイプです. この情報は(byte[])である場合のタイプを指定します.

関連項目:
定数フィールド値

TYPE_SHORT

static final int TYPE_SHORT
指定データタイプ : 2バイト数値情報.

2バイト数値属性の指定データタイプです. この情報は(short[])である場合のタイプを指定します.

関連項目:
定数フィールド値

TYPE_INT

static final int TYPE_INT
指定データタイプ : 4バイト数値情報.

4バイト数値属性の指定データタイプです. この情報は(int[])である場合のタイプを指定します.

関連項目:
定数フィールド値

TYPE_LONG

static final int TYPE_LONG
指定データタイプ : 8バイト数値情報.

8バイト数値属性の指定データタイプです. この情報は(long[])である場合のタイプを指定します.

関連項目:
定数フィールド値

TYPE_DATE

static final int TYPE_DATE
指定データタイプ : 日付データ情報.

日付データ属性の指定データタイプです. この情報は(java.util.Date)である場合のタイプを指定します.

関連項目:
定数フィールド値

TYPE_CALENDAR

static final int TYPE_CALENDAR
指定データタイプ : カレンダデータ情報.

カレンダデータ属性の指定データタイプです. この情報は(java.util.Calendar)である場合のタイプを指定します.

関連項目:
定数フィールド値

TYPE_DATETIME

static final int TYPE_DATETIME
指定データタイプ : 日付・時間データ情報.

日付・時間データ属性の指定データタイプです. この情報は(DateTime)である場合のタイプを指定します.

関連項目:
定数フィールド値

TYPE_STRING

static final int TYPE_STRING
指定データタイプ : 文字列情報.

文字列情報属性の指定データタイプです. この情報は(String)である場合のタイプを指定します.

関連項目:
定数フィールド値
メソッドの詳細

create

void create(java.lang.String format)
            throws InputException,
                   ReadSyntaxException
フォーマット設定.

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

パラメータ:
format - 対象のフォーマットデータを設定します.
例外:
InputException - 入力例外.
ReadSyntaxException - 読み込み構文例外.

clear

void clear()
情報クリア.

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


getParam

int getParam(int no)
             throws InputException
パラメータ属性の取得.

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

パラメータ:
no - 取得対象の項番を指定します.
戻り値:
int パラメータ属性が返されます.
例外:
InputException - 入力例外.

getParamToOutLength

int getParamToOutLength(int no)
                        throws InputException
パラメータ属性での、出力情報数の取得.

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

パラメータ:
no - 取得対象の項番を指定します.
戻り値:
int パラメータに対する出力最大長が返されます.
[LogFormat.OUT_LENGTH_TO_NOTHING]が返された場合、 出力情報数は特に指定されていません.
例外:
InputException - 入力例外.

getPause

java.lang.String getPause(int no)
                          throws InputException
区切り情報の取得.

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

パラメータ:
no - 取得対象の項番を指定します.
戻り値:
String 区切り情報が返されます.
例外:
InputException - 入力例外.

getParameterLength

int getParameterLength()
パラメータ数取得.

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

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

getPauseLength

int getPauseLength()
区切り情報数取得.

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

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

getFormatPattern

int getFormatPattern(int no)
                     throws InputException
フォーマットデータ並びの取得.

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

パラメータ:
no - 取得対象のデータ並び順の項番を指定します.
戻り値:
int フォーマット並び順が返されます.
[LogFormat#PATTERN_PARAMETER]が返された場合、 対象情報はパラメータ情報です.
[LogFormat#PATTERN_PAUSE]が返された場合、 対象情報は区切り情報です.
例外:
InputException - 入力例外.

getFormatPatternLength

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

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

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

getFormat

java.lang.String getFormat()
設定フォーマット情報の取得.

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

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

isCreate

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

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

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