概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## kinugasa.contents.text
クラス XMLReader

    java.lang.Object
      kinugasa.contents.text.TextIO<XMLElement>
          kinugasa.contents.text.XMLReader

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

    public final class XMLReader

extends TextIO<XMLElement>
implements Freeable

Kinugasa : XMLReader : XMLファイルの展開とデータの管理を行います.
XMLデータはXMLElementクラスを使用し、木構造で表現されます。 ロードされたXMLReaderが持つノードは、ルートの1つのみです。
ロード時には、DTDの検査が行われます。DTDが到達できないパスに配置されている場合や不正な DTDパスを指定した場合はCoutentsFileNotFoundExceptionが投げられます。

バージョン:
  1.0.0 - 2013/03/15_11:48:01.
作成者:
  dra0211 ( d0211@live.jp ).
関連項目:
  直列化された形式

フィールドの概要
`private static long` | `serialVersionUID`

クラス kinugasa.contents.text.TextIO から継承されたフィールド
`data, file`

コンストラクタの概要
`XMLReader(java.io.File file)`
`XMLReader(java.lang.String filePath)`

メソッドの概要
`XMLReader` | `add(java.util.Collection<? extends XMLElement> obj)` 要素をこのテキストファイルの末尾に追加します.
`XMLReader` | `add(TextIO<? extends XMLElement> other)` 他のTextIOのすべての要素を、このテキストファイルの末尾に追加します.
`XMLReader` | `add(XMLElement... obj)` 要素をこのテキストファイルの末尾に追加します.
`XMLReader` | `add(XMLElement obj)` 要素をこのテキストファイルの末尾に追加します.
`XMLReader` | `clear()` 全ての要素を破棄します.
`XMLReader` | `free()` コンテンツをメモリから破棄出来るようにします.
`boolean` | `isLoaded()` このオブジェクトが、すでにロードされているかを検査します.
`XMLReader` | `load()` コンテンツをロードして展開します.
`private static javax.xml.parsers.DocumentBuilderFactory` | `openBuilderFactory()`
`XMLReader` | `remove(java.util.Collection<? extends XMLElement> obj)` 要素をこのテキストファイルから削除します.
`XMLReader` | `remove(TextIO<? extends XMLElement> other)` 他のTextIOのすべての要素を、このテキストファイルから削除します.
`XMLReader` | `remove(XMLElement... obj)` 要素をこのテキストファイルから削除します.
`XMLReader` | `remove(XMLElement obj)` 要素をこのテキストファイルから削除します.

クラス 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`

フィールドの詳細

### serialVersionUID

    private static final long serialVersionUID

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

コンストラクタの詳細

### XMLReader

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

例外:
  `ContentsFileNotFoundException`

### XMLReader

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

例外:
  `ContentsFileNotFoundException`

メソッドの詳細

### openBuilderFactory

    private static javax.xml.parsers.DocumentBuilderFactory openBuilderFactory()

### load

    public XMLReader load()
                   throws IllegalXMLFormatException,
                          ContentsFileNotFoundException,
                          ContentsIOException

  インタフェース `Freeable` の記述:
  コンテンツをロードして展開します. すでにロードされている場合の動作は、実装によって異なります。
  再度ロードすることで、データを最新のものに更新するなど、効果のある場合には、すでにロードされている場合でも 再度ロードすることがあります。

  定義:
    インタフェース `Freeable` 内の `load`
  戻り値:
    インスタンス化と同時にロードするために、thisインスタンスを返します。戻り値は 適切な型にキャストする必要があります。
  例外:
    `IllegalXMLFormatException`
    `ContentsFileNotFoundException`
    `ContentsIOException`

### free

    public XMLReader free()

  インタフェース `Freeable` の記述:
  コンテンツをメモリから破棄出来るようにします. 実際にメモリから破棄されるタイミングは、GCに依存します。
  まだロードされていないか、開放済みのオブジェクトを開放した場合には、通常は何も行いません。

  定義:
    インタフェース `Freeable` 内の `free`
  戻り値:
    デフォルトでロードされる実装を、インスタンス化と同時に開放するためにthisインスタンスを返します。
    戻り値は適切な型にキャストする必要があります。通常、このような実装は効率的でないため推奨されません。

### isLoaded

    public boolean isLoaded()

  インタフェース `Freeable` の記述:
  このオブジェクトが、すでにロードされているかを検査します.

  定義:
    インタフェース `Freeable` 内の `isLoaded`
  戻り値:
    ロード済みである場合はtrueを返します。

### add

    public XMLReader add(java.util.Collection<? extends XMLElement> obj)

  クラス `TextIO` の記述:
  要素をこのテキストファイルの末尾に追加します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.add()をコールする必要があります。

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `add`
  パラメータ:
    `obj` - 追加するオブジェクトを指定します。
  戻り値:
    thisインスタンスを返します。

### add

    public XMLReader add(TextIO<? extends XMLElement> other)

  クラス `TextIO` の記述:
  他のTextIOのすべての要素を、このテキストファイルの末尾に追加します. このメソッドは、読み込み用TextIOからロードしたデータを書き込み用TextIOに発行する場合に有用です。
  このメソッドは、TextIOのすべての実装でオーバーライドし、super.add()をコールする必要があります。

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `add`
  パラメータ:
    `other` - 追加するオブジェクトが含まれたTextIOを指定します。
  戻り値:
    thisインスタンスを返します。

### add

    public XMLReader add(XMLElement obj)

  クラス `TextIO` の記述:
  要素をこのテキストファイルの末尾に追加します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.add()をコールする必要があります。

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `add`
  パラメータ:
    `obj` - 追加するオブジェクトを指定します。
  戻り値:
    thisインスタンスを返します。

### add

    public XMLReader add(XMLElement... obj)

  クラス `TextIO` の記述:
  要素をこのテキストファイルの末尾に追加します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.add()をコールする必要があります。

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `add`
  パラメータ:
    `obj` - 追加するオブジェクトを指定します。
  戻り値:
    thisインスタンスを返します。

### clear

    public XMLReader clear()

  クラス `TextIO` の記述:
  全ての要素を破棄します.

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `clear`
  戻り値:
    thisインスタンスを返します。

### remove

    public XMLReader remove(java.util.Collection<? extends XMLElement> obj)

  クラス `TextIO` の記述:
  要素をこのテキストファイルから削除します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.remove()をコールする必要があります。

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `remove`
  パラメータ:
    `obj` - 削除するオブジェクトを指定します。
  戻り値:
    thisインスタンスを返します。

### remove

    public XMLReader remove(TextIO<? extends XMLElement> other)

  クラス `TextIO` の記述:
  他のTextIOのすべての要素を、このテキストファイルから削除します. このメソッドは、読み込み用TextIOからロードしたデータを書き込み用TextIOに発行する場合に有用です。
  このメソッドは、TextIOのすべての実装でオーバーライドし、super.remove()をコールする必要があります。

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `remove`
  パラメータ:
    `other` - 削除するオブジェクトが含まれたTextIOを指定します。
  戻り値:
    thisインスタンスを返します。

### remove

    public XMLReader remove(XMLElement obj)

  クラス `TextIO` の記述:
  要素をこのテキストファイルから削除します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.remove()をコールする必要があります。

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `remove`
  パラメータ:
    `obj` - 削除するオブジェクトを指定します。
  戻り値:
    thisインスタンスを返します。

### remove

    public XMLReader remove(XMLElement... obj)

  クラス `TextIO` の記述:
  要素をこのテキストファイルから削除します. このメソッドは、TextIOのすべての実装でオーバーライドし、super.remove()をコールする必要があります。

  オーバーライド:
    クラス `TextIO<XMLElement>` 内の `remove`
  パラメータ:
    `obj` - 削除するオブジェクトを指定します。
  戻り値:
    thisインスタンスを返します。

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引 | ヘルプ
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド