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

public interface CustomLogConfig

CustomLogコンフィグ解析処理.

CustomLogコンフィグ解析処理を提供します.

導入されたバージョン:

JDK 1.3

バージョン:

1.00, 2005/02/23

作成者:

Masahito Suzuki

メソッドの概要

void	clear() オブジェクトクリア.
void	create(java.lang.String name) カスタムログ生成処理.
CommonConfig	getConfig() コンフィグオブジェクトの取得.
java.lang.String	getCustomLogCharset() カスタムログキャラクターセットを取得.
java.lang.String	getCustomLogDayFormat() カスタムログ日付フォーマットを取得.
java.lang.String	getCustomLogLevelMask(int no) カスタムログレベルマスクを取得.
int	getCustomLogLevelMaskLength() カスタムログレベルマスクを取得.
boolean	getCustomLogMode() カスタムログモードを取得.
java.lang.String	getCustomLogName() カスタムログ名を取得.
java.lang.String	getCustomLogOutputDirectory() カスタムログ出力先ディレクトリ名を取得.
java.lang.String	getCustomLogOutputFile() カスタムログ出力先ファイル名を取得.
java.lang.String	getCustomLogPlus() カスタムログ拡張子を取得.
int	getCustomLogUpdateTime() カスタムログアップデート時間を取得.
java.lang.String	getCustomStyleFile() カスタムスタイルファイル名を取得.
int	getMaxCustomLog() カスタムログ出力ファイル管理最大長を取得.
boolean	isSection(java.lang.String section) 対象セクション名存在チェック.
boolean	isUseSection() 定義ファイル[jrcserver.conf]で必要なセクション名群が有効であるかチェック.

メソッドの詳細

create

void create(java.lang.String name)
            throws ExecutionException

カスタムログ生成処理.

カスタムログファイル名を指定してオープンします.

パラメータ:

name - オープン対象のファイル名を設定します.

例外:

ExecutionException - 実行例外.

clear

void clear()

オブジェクトクリア.

オブジェクト情報をクリアします.

getCustomLogName

java.lang.String getCustomLogName()

カスタムログ名を取得.

カスタムログ名を取得します.
この情報はセクション名[custom-log]以下に 設定されている[name]情報を取得します.

戻り値:

String カスタムログ名が返されます.
情報が存在しない場合[null]が返されます.

getCustomStyleFile

java.lang.String getCustomStyleFile()

カスタムスタイルファイル名を取得.

カスタムスタイルファイル名を取得します.
この情報はセクション名[custom-log]以下に 設定されている[style]情報を取得します.

戻り値:

String カスタムスタイルファイル名が返されます.
情報が存在しない場合[null]が返されます.

getCustomLogOutputFile

java.lang.String getCustomLogOutputFile()

カスタムログ出力先ファイル名を取得.

カスタムログ出力先ファイル名を取得します.
この情報はセクション名[custom-log]以下に 設定されている[output-name]情報を取得します.

戻り値:

String カスタムログ出力先ファイル名が返されます.
情報が存在しない場合[null]が返されます.

getCustomLogOutputDirectory

java.lang.String getCustomLogOutputDirectory()

カスタムログ出力先ディレクトリ名を取得.

カスタムログ出力先ディレクトリ名を取得します.
この情報はセクション名[custom-log]以下に 設定されている[output-directory]情報を取得します.

戻り値:

String カスタムログ出力先ディレクトリ名が返されます.
情報が存在しない場合[null]が返されます.

getCustomLogMode

boolean getCustomLogMode()

カスタムログモードを取得.

カスタムログモードを取得します.
この情報はセクション名[custom-log]以下に 設定されている[mode]情報を取得します.

戻り値:

boolean カスタムログモードが返されます.
[true]が返された場合、スレッドモードで実行します.
[false]が返された場合、非スレッドモードで実行します.

getMaxCustomLog

int getMaxCustomLog()

カスタムログ出力ファイル管理最大長を取得.

カスタムログ出力ファイル管理最大長を取得します.
この情報はセクション名[custom-log]以下に 設定されている[max]情報を取得します.

戻り値:

int カスタムログ出力ファイル管理最大長が返されます.
情報が存在しない場合[-1]が返されます.

getCustomLogLevelMask

java.lang.String getCustomLogLevelMask(int no)

カスタムログレベルマスクを取得.

カスタムログレベルマスクを取得します.
この情報はセクション名[custom-log]以下に 設定されている[level-mask]情報を取得します.

パラメータ:

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

戻り値:

String カスタムログレベルマスクが返されます.
情報が存在しない場合[null]が返されます.

getCustomLogLevelMaskLength

int getCustomLogLevelMaskLength()

カスタムログレベルマスクを取得.

カスタムログレベルマスクを取得します.
この情報はセクション名[custom-log]以下に 設定されている[level-mask]情報を取得します.

戻り値:

int 定義数が返されます.

getCustomLogUpdateTime

int getCustomLogUpdateTime()

カスタムログアップデート時間を取得.

カスタムログアップデート時間を取得します.
この情報はセクション名[custom-log]以下に 設定されている[update-time]情報を取得します.

戻り値:

int カスタムログアップデート時間が返されます.
情報が存在しない場合[-1]が返されます.

getCustomLogCharset

java.lang.String getCustomLogCharset()

カスタムログキャラクターセットを取得.

カスタムログキャラクターセットを取得します.
この情報はセクション名[custom-log]以下に 設定されている[charset]情報を取得します.

戻り値:

String カスタムログキャラクターセットが返されます.
情報が存在しない場合[null]が返されます.

getCustomLogDayFormat

java.lang.String getCustomLogDayFormat()

カスタムログ日付フォーマットを取得.

カスタムログ日付フォーマットを取得します.
この情報はセクション名[custom-log]以下に 設定されている[day-format]情報を取得します.

戻り値:

String カスタムログ日付フォーマットが返されます.
情報が存在しない場合[null]が返されます.

getCustomLogPlus

java.lang.String getCustomLogPlus()

カスタムログ拡張子を取得.

カスタムログ拡張子を取得します.
この情報はセクション名[custom-log]以下に 設定されている[plus]情報を取得します.

戻り値:

String カスタムログ拡張子が返されます.
情報が存在しない場合[null]が返されます.

getConfig

CommonConfig getConfig()

コンフィグオブジェクトの取得.

コンフィグオブジェクトを取得します.

戻り値:

CommonConfig コンフィグオブジェクトが返されます.
オブジェクトがオープンされていない場合[null]が返されます.

isUseSection

boolean isUseSection()

定義ファイル[jrcserver.conf]で必要なセクション名群が有効であるかチェック.

定義ファイル[jrcserver.conf]で必要なセクション名群が有効であるかチェックします.

戻り値:

boolean 有効であるかチェックします.
[true]が返された場合、有効です.
[false]が返された場合、有効ではありません.

isSection

boolean isSection(java.lang.String section)

対象セクション名存在チェック.

対象のセクション名が存在するかチェックします.

パラメータ:

section - 対象のセクション名を設定します.

戻り値:

boolean 存在結果が返されます.
[true]が返された場合、セクション名は存在します.
[false]が返された場合、セクション名は存在しません.