com.JRcServer.commons.conf
クラス BaseConfig

java.lang.Object
  上位を拡張 com.JRcServer.commons.conf.BaseConfig

public abstract class BaseConfig
extends java.lang.Object

基本コンフィグオブジェクト.

基本コンフィグオブジェクトです.
基本的に、コンフィグ情報を呼び出す場合、 このオブジェクトを継承して行う必要があります.

導入されたバージョン:
JRcCommons 1.00
バージョン:
1.00, 2005/12/25
作成者:
Masahito Suzuki

コンストラクタの概要
BaseConfig()
          コンストラクタ.
 
メソッドの概要
 void close()
          オブジェクトクリア.
 CommonConfig getConfig()
          コンフィグオブジェクトの取得.
 java.lang.String getName()
          対象コンフィグファイル名を取得.
 long getTime()
          ファイル最終更新時間を取得.
 boolean isRead()
          読み込みチェック.
 boolean isSection(java.lang.String section)
          対象セクション名存在チェック.
abstract  boolean isUseSection()
          対象コンフィグで必要なセクション名群が有効であるか チェック.
 void open(java.lang.String name)
          指定iniファイルをオープン.
 void reload()
          コンフィグ情報再読込み.
 java.lang.String toString()
          コンフィグ情報を文字列に出力.
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

コンストラクタの詳細

BaseConfig

public BaseConfig()
コンストラクタ.

メソッドの詳細

open

public final void open(java.lang.String name)
                throws InputException,
                       FileAccessException,
                       ReadSyntaxException
指定iniファイルをオープン.

指定されたIniファイルをオープンします.

パラメータ:
name - オープン対象のファイル名を設定します.
例外:
InputException - 入力例外.
FileAccessException - ファイルアクセス例外.
ReadSyntaxException - 読み込み構文例外.

close

public final void close()
オブジェクトクリア.

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


reload

public final void reload()
コンフィグ情報再読込み.

現在オープンされているコンフィグ情報を再読込みします.


getConfig

public final CommonConfig getConfig()
コンフィグオブジェクトの取得.

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

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

getName

public final java.lang.String getName()
対象コンフィグファイル名を取得.

対象のコンフィグファイル名を取得します.

戻り値:
String コンフィグファイル名が返されます.

getTime

public final long getTime()
ファイル最終更新時間を取得.

現在読み込み中の対象ファイルの更新時間が返されます.

戻り値:
long ファイル更新時間が返されます.

isUseSection

public abstract boolean isUseSection()
対象コンフィグで必要なセクション名群が有効であるか チェック.

対象コンフィグで必要なセクション名群が有効であるか チェックします.

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

isRead

public final boolean isRead()
読み込みチェック.

定義ファイルが正常に読み込まれているかチェックします.

戻り値:
boolean 正常に読み込まれているかチェックします.
[true]が返された場合、正常に読み込まれています.
[false]が返された場合、正常に読み込まれていないか クリアされています.

isSection

public boolean isSection(java.lang.String section)
対象セクション名存在チェック.

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

パラメータ:
section - 対象のセクション名を設定します.
戻り値:
boolean 存在結果が返されます.
[true]が返された場合、セクション名は存在します.
[false]が返された場合、セクション名は存在しません.

toString

public final java.lang.String toString()
コンフィグ情報を文字列に出力.

コンフィグ情報を文字列に出力します.

オーバーライド:
クラス java.lang.Object 内の toString
戻り値:
String コンフィグ内容が返されます.