kinugasa.contents.text

## クラス INIReader

- java.lang.Object
- - kinugasa.contents.text.TextIO<T>
  - - kinugasa.contents.text.TextReader<Property>
    - - kinugasa.contents.text.INIReader

- すべての実装されたインタフェース:
    java.io.Serializable, java.lang.Iterable<Property>, Freeable, Loadable, Nameable

      public final class INIReader
      extends TextReader<Property>

  INIファイルをロードするためのテキストリーダの実装です.
  #で始まる行はコメントとして扱われます。空行は無視されます。
  関連項目:
    直列化された形式

- - ### フィールドのサマリー

    - ### クラスから継承されたフィールド kinugasa.contents.text.TextIO

      `data, file`

  - ### コンストラクタのサマリー

    コンストラクタ
    コンストラクタと説明
    `INIReader(java.io.File file)` ファイルを指定して、読み込み用のINIファイルを作成します.
    `INIReader(java.lang.String filePath)` ファイルパスを指定して、読み込み用のINIファイルを作成します.

  - ### メソッドのサマリー

    All Methods Instance Methods Concrete Methods
    修飾子とタイプ | メソッドと説明
    --- | ---
    `INIReader` | `add(java.util.Collection<? extends Property> obj)` 要素をこのテキストファイルの末尾に追加します.
    `INIReader` | `add(Property... obj)` 要素をこのテキストファイルの末尾に追加します.
    `INIReader` | `add(Property obj)` 要素をこのテキストファイルの末尾に追加します.
    `INIReader` | `add(TextIO<? extends Property> other)` 他のTextIOのすべての要素を、このテキストファイルの末尾に追加します.
    `INIReader` | `clear()` 全ての要素を破棄します.
    `boolean` | `contains(java.lang.String name)` 指定した名前を持つ要素が含まれているかを検査します。
    `INIReader` | `free()` 全てのデータを破棄します.
    `Property` | `get(java.lang.String name)` 指定した名前を持つ要素を検索して返します.
    `Property` | `getIfContains(java.lang.String name)` 指定した名前を持つ要素を検索して返します.
    `INIReader` | `load()` テキストファイルのデータをロードします.
    `INIReader` | `remove(java.util.Collection<? extends Property> obj)` 要素をこのテキストファイルから削除します.
    `INIReader` | `remove(Property... obj)` 要素をこのテキストファイルから削除します.
    `INIReader` | `remove(Property obj)` 要素をこのテキストファイルから削除します.
    `INIReader` | `remove(TextIO<? extends Property> other)` 他のTextIOのすべての要素を、このテキストファイルから削除します.

    - ### クラスから継承されたメソッド kinugasa.contents.text.TextReader

      `getReader, isLoaded, setReader`

    - ### クラスから継承されたメソッド kinugasa.contents.text.TextIO

      `getData, getFile, getFirst, getName, isEmpty, iterator, printAll, size, toString`

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

    - ### インタフェースから継承されたメソッド java.lang.Iterable

      `forEach, spliterator`

- - ### コンストラクタの詳細

    - #### INIReader

          public INIReader(java.io.File file)
                    throws ContentsFileNotFoundException

      ファイルを指定して、読み込み用のINIファイルを作成します.
      パラメータ:
        `file` - ファイルを指定します。
      例外:
        `ContentsFileNotFoundException` - 指定されたファイルが存在しない場合に投げられます。

    - #### INIReader

          public INIReader(java.lang.String filePath)
                    throws ContentsFileNotFoundException

      ファイルパスを指定して、読み込み用のINIファイルを作成します.
      パラメータ:
        `filePath` - ファイルパスを指定します。
      例外:
        `ContentsFileNotFoundException` - 指定されたファイルが存在しない場合に投げられます。

  - ### メソッドの詳細

    - #### load

          public INIReader load()
                         throws IllegalFormatException

      クラスからコピーされた説明: `TextReader`
      テキストファイルのデータをロードします.
      定義:
        `load` インタフェース内 `Loadable`
      オーバーライド:
        `load` クラス内 `TextReader<Property>`
      戻り値:
        thisインスタンスを返します。
      例外:
        `IllegalFormatException` - パーサが文字列を解析できない場合に投げられます。

    - #### free

          public INIReader free()

      クラスからコピーされた説明: `TextReader`
      全てのデータを破棄します.
      定義:
        `free` インタフェース内 `Freeable`
      オーバーライド:
        `free` クラス内 `TextReader<Property>`
      戻り値:
        thisインスタンスを返します。

    - #### get

          public Property get(java.lang.String name)
                       throws NameNotFoundException

      指定した名前を持つ要素を検索して返します.
      パラメータ:
        `name` - Peopertyの名前を指定します。
      戻り値:
        指定された名前を持つPropertyを返します。
      例外:
        `NameNotFoundException` - 指定された名前のオブジェクトが発見できなかった場合に投げられます。

    - #### getIfContains

          public Property getIfContains(java.lang.String name)

      指定した名前を持つ要素を検索して返します.
      パラメータ:
        `name` - Peopertyの名前を指定します。
      戻り値:
        指定された名前を持つPropertyを返します。発見できなかった場合はnullを返します。

    - #### contains

          public boolean contains(java.lang.String name)

      指定した名前を持つ要素が含まれているかを検査します。
      パラメータ:
        `name` - Peopertyの名前を指定します。
      戻り値:
        指定された名前を持つPropertyが含まれていればtrueを返します。

    - #### add

          public INIReader add(java.util.Collection<? extends Property> obj)

      クラスからコピーされた説明: `TextIO`
      要素をこのテキストファイルの末尾に追加します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.add()をコールする必要があります。
      オーバーライド:
        `add` クラス内 `TextReader<Property>`
      パラメータ:
        `obj` - 追加するオブジェクトを指定します。
      戻り値:
        thisインスタンスを返します。

    - #### add

          public INIReader add(Property obj)

      クラスからコピーされた説明: `TextIO`
      要素をこのテキストファイルの末尾に追加します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.add()をコールする必要があります。
      オーバーライド:
        `add` クラス内 `TextReader<Property>`
      パラメータ:
        `obj` - 追加するオブジェクトを指定します。
      戻り値:
        thisインスタンスを返します。

    - #### add

          public INIReader add(Property... obj)

      クラスからコピーされた説明: `TextIO`
      要素をこのテキストファイルの末尾に追加します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.add()をコールする必要があります。
      オーバーライド:
        `add` クラス内 `TextReader<Property>`
      パラメータ:
        `obj` - 追加するオブジェクトを指定します。
      戻り値:
        thisインスタンスを返します。

    - #### add

          public INIReader add(TextIO<? extends Property> other)

      クラスからコピーされた説明: `TextIO`
      他のTextIOのすべての要素を、このテキストファイルの末尾に追加します. このメソッドは、読み込み用TextIOからロードしたデータを書き込み用TextIOに発行する場合に有用です。
      このメソッドは、TextIOのすべての実装でオーバーライドし、super.add()をコールする必要があります。
      オーバーライド:
        `add` クラス内 `TextReader<Property>`
      パラメータ:
        `other` - 追加するオブジェクトが含まれたTextIOを指定します。
      戻り値:
        thisインスタンスを返します。

    - #### remove

          public INIReader remove(java.util.Collection<? extends Property> obj)

      クラスからコピーされた説明: `TextIO`
      要素をこのテキストファイルから削除します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.remove()をコールする必要があります。
      オーバーライド:
        `remove` クラス内 `TextReader<Property>`
      パラメータ:
        `obj` - 削除するオブジェクトを指定します。
      戻り値:
        thisインスタンスを返します。

    - #### remove

          public INIReader remove(Property obj)

      クラスからコピーされた説明: `TextIO`
      要素をこのテキストファイルから削除します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.remove()をコールする必要があります。
      オーバーライド:
        `remove` クラス内 `TextReader<Property>`
      パラメータ:
        `obj` - 削除するオブジェクトを指定します。
      戻り値:
        thisインスタンスを返します。

    - #### remove

          public INIReader remove(Property... obj)

      クラスからコピーされた説明: `TextIO`
      要素をこのテキストファイルから削除します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.remove()をコールする必要があります。
      オーバーライド:
        `remove` クラス内 `TextReader<Property>`
      パラメータ:
        `obj` - 削除するオブジェクトを指定します。
      戻り値:
        thisインスタンスを返します。

    - #### remove

          public INIReader remove(TextIO<? extends Property> other)

      クラスからコピーされた説明: `TextIO`
      他のTextIOのすべての要素を、このテキストファイルから削除します. このメソッドは、読み込み用TextIOからロードしたデータを書き込み用TextIOに発行する場合に有用です。
      このメソッドは、TextIOのすべての実装でオーバーライドし、super.remove()をコールする必要があります。
      オーバーライド:
        `remove` クラス内 `TextReader<Property>`
      パラメータ:
        `other` - 削除するオブジェクトが含まれたTextIOを指定します。
      戻り値:
        thisインスタンスを返します。

    - #### clear

          public INIReader clear()

      クラスからコピーされた説明: `TextIO`
      全ての要素を破棄します.
      オーバーライド:
        `clear` クラス内 `TextReader<Property>`
      戻り値:
        thisインスタンスを返します。