com.JRcServer.commons.util.read
クラス ReadIni

java.lang.Object
  上位を拡張 com.JRcServer.commons.util.read.ReadIni

public class ReadIni
extends java.lang.Object

INIファイル読み込み用オブジェクト.

INIファイルの読み込みをサポートします.

導入されたバージョン:
JRcCommons 1.00
バージョン:
1.00, 2004/05/01
作成者:
Masahito Suzuki

コンストラクタの概要
ReadIni()
          コンストラクタ.
ReadIni(ListDirectory vdir, java.lang.String pwd)
          コンストラクタ.
 
メソッドの概要
 void clear()
          情報クリア.
 void create(ReadIndex index)
          情報生成.
 java.lang.String get(java.lang.String section, java.lang.String key, int no)
          対象情報を取得.
 java.lang.String[] getAll(java.lang.String section, java.lang.String key)
          対象情報を取得.
 int getElements(java.lang.String section, java.lang.String key)
          対象キーワード名存在チェック.
 int getKeywordElements(java.lang.String section)
          対象セクション内キーワード数の取得.
 java.lang.String[] getKeywords(java.lang.String section)
          キーワード名群の取得.
 int getSectionElements()
          対象セクション名数の取得.
 java.lang.String[] getSections()
          セクション名群の取得.
 ListDirectory getVirtualDirectory()
          仮想ディレクトリ情報の取得.
 boolean isKeyword(java.lang.String section, java.lang.String key)
          対象キーワード名存在チェック.
 boolean isSection(java.lang.String section)
          対象セクション名存在チェック.
 
クラス java.lang.Object から継承されたメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

ReadIni

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


ReadIni

public ReadIni(ListDirectory vdir,
               java.lang.String pwd)
        throws InputException
コンストラクタ.

INIファイル管理仮想ディレクトリ情報を設定します.

パラメータ:
vdir - 仮想ディレクトリ情報を設定します.
pwd - 書き込み位置ディレクトリパスを設定します.
例外:
InputException - 入力例外.
メソッドの詳細

create

public final void create(ReadIndex index)
                  throws InputException,
                         ReadSyntaxException
情報生成.

対象のIndex情報から、情報を取得します.

パラメータ:
index - INI情報取得対象のINDEX情報を設定します.
例外:
InputException - 入力例外.
ReadSyntaxException - 読み込み構文例外.

clear

public final void clear()
情報クリア.

情報をクリアします.
また、コンストラクタ[ReadIni( ListDirectory,String )]で オブジェクトを生成している場合、この処理を呼び出すと、 第一引数で渡した情報内容もがクリアされてしまいます.


getVirtualDirectory

public final ListDirectory getVirtualDirectory()
仮想ディレクトリ情報の取得.

対象の仮想ディレクトリ情報を取得します.

戻り値:
ListDirectory 管理されている仮想ディレクトリ情報が返されます.

get

public final java.lang.String get(java.lang.String section,
                                  java.lang.String key,
                                  int no)
                           throws InputException,
                                  NotExistException
対象情報を取得.

INI情報として、格納されているキーワードに対する 情報を取得します.

パラメータ:
section - 対象のセクション名を設定します.
[null]を設定した場合、セクション名を設定しないことを 意味します.
key - 対象のキーワード情報を設定します.
no - 対象キーワードに対する取得項番を設定します.
戻り値:
String 格納されている情報が返されます.
例外:
InputException - 入力例外.
NotExistException - 情報非存在例外.

getAll

public final java.lang.String[] getAll(java.lang.String section,
                                       java.lang.String key)
                                throws InputException,
                                       NotExistException
対象情報を取得.

INI情報として、格納されているキーワードに対する 全ての情報を取得します.

パラメータ:
section - 対象のセクション名を設定します.
[null]を設定した場合、セクション名を設定しないことを 意味します.
key - 対象のキーワード情報を設定します.
戻り値:
String[] 格納されている情報が返されます.
例外:
InputException - 入力例外.
NotExistException - 情報非存在例外.

getSections

public final java.lang.String[] getSections()
セクション名群の取得.

対象のセクション名群を取得します.

戻り値:
String[] 対象のセクション名群が返されます.

getSectionElements

public final int getSectionElements()
対象セクション名数の取得.

対象のセクション名数を取得します.

戻り値:
int 対象のセクション名数が返されます.

getKeywords

public final java.lang.String[] getKeywords(java.lang.String section)
                                     throws NotExistException
キーワード名群の取得.

対象のキーワード名群を取得します.

パラメータ:
section - 対象のセクション名を設定します.
[null]を設定した場合、セクション名を設定しないことを 意味します.
戻り値:
String[] 対象のキーワード名群が返されます.
例外:
NotExistException - 非存在例外.

getKeywordElements

public final int getKeywordElements(java.lang.String section)
                             throws NotExistException
対象セクション内キーワード数の取得.

対象のセクション内のキーワード数を取得します.

パラメータ:
section - 対象のセクション名を設定します.
[null]を設定した場合、セクション名を設定しないことを 意味します.
戻り値:
int 格納キーワード数が返されます.
例外:
NotExistException - 非存在例外.
この例外が返された場合、対象のセクション名は 存在しません.

getElements

public final int getElements(java.lang.String section,
                             java.lang.String key)
                      throws NotExistException
対象キーワード名存在チェック.

対象のキーワード名が存在するかチェックします.
また、存在する場合、その個数を返します.

パラメータ:
section - 対象のセクション名を設定します.
[null]を設定した場合、セクション名を設定しないことを 意味します.
key - 対象のキーワード名を設定します.
戻り値:
int 格納キーワード数が返されます.
例外:
NotExistException - 非存在例外.
この例外が返された場合、対象のセクション名は 存在しません.

isSection

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

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

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

isKeyword

public final boolean isKeyword(java.lang.String section,
                               java.lang.String key)
対象キーワード名存在チェック.

対象のキーワード名が存在するかチェックします.
また、存在する場合、その個数を返します.

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