kinugasa.rpgui

## クラス XMLFieldMapBuilder

- java.lang.Object
- - kinugasa.rpgui.XMLFieldMapBuilder

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

      public final class XMLFieldMapBuilder
      extends java.lang.Object
      implements FieldMapBuilder

  フィールドマップをXMLからロードするためのビルダです.
  作成されたFieldMapBuilderは自動的にFieldMapBuildetStorageに追加されます。
  備忘：BackgroundSpriteの表示サイズは、FieldMapBuilderのXMLに記載された幅・高さに依存する。

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

    コンストラクタ
    コンストラクタと説明
    `XMLFieldMapBuilder(java.lang.String name, SoundMap soundMap, NodeMap nodeMap, XMLReader dataFileReader, java.lang.String textDataPath, int x, int y)`

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

    All Methods Instance Methods Concrete Methods
    修飾子とタイプ | メソッドと説明
    --- | ---
    `int` | `compareTo(FieldMapBuilder o)`
    `XMLFieldMapBuilder` | `free()` コンテンツをメモリから破棄出来るようにします.
    `XMLFieldMapBuilder` | `freeSound()`
    `int` | `getChipHeight()`
    `int` | `getChipWidth()`
    `XMLReader` | `getDataFileReader()`
    `FieldMap` | `getFieldMap()`
    `MessageWindowSprite` | `getMessageWindowSprite()`
    `java.lang.String` | `getName()` このインスタンスの一意的な名前を取得します.
    `NodeMap` | `getNodeMap()`
    `SoundMap` | `getSoundMap()`
    `TextStorage` | `getTextStorage()`
    `boolean` | `isLoaded()` このオブジェクトが、すでにロードされているかを検査します.
    `XMLFieldMapBuilder` | `load()` コンテンツをロードして展開します.
    `void` | `setDataFileReader(XMLReader dataFileReader)`
    `void` | `setNodeMap(NodeMap nodeMap)`
    `void` | `setSoundMap(SoundMap soundMap)`
    `java.lang.String` | `toString()`

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

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

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

    - #### XMLFieldMapBuilder

          public XMLFieldMapBuilder(java.lang.String name,
                                    SoundMap soundMap,
                                    NodeMap nodeMap,
                                    XMLReader dataFileReader,
                                    java.lang.String textDataPath,
                                    int x,
                                    int y)

  - ### メソッドの詳細

    - #### getName

          public java.lang.String getName()

      インタフェースからコピーされた説明: `Nameable`
      このインスタンスの一意的な名前を取得します. 名前はゲームの実行中変更されてはなりません。
      定義:
        `getName` インタフェース内 `Nameable`
      定義:
        `getName` インタフェース内 `FieldMapBuilder`
      戻り値:
        このインスタンスを識別できる一意的な名前を返します。名前はユーザやプレイヤーが指定する可能性があるため 意味のある文字列を推奨します。

    - #### getFieldMap

          public FieldMap getFieldMap()
                               throws NotYetLoadedException

      定義:
        `getFieldMap` インタフェース内 `FieldMapBuilder`
      例外:
        `NotYetLoadedException`

    - #### load

          public XMLFieldMapBuilder load()
                                  throws IllegalXMLFormatException,
                                         java.lang.NumberFormatException,
                                         NameNotFoundException,
                                         java.awt.image.RasterFormatException,
                                         ReflectionClassNotFoundException

      インタフェースからコピーされた説明: `Loadable`
      コンテンツをロードして展開します. すでにロードされている場合の動作は、実装によって異なります。
      再度ロードすることで、データを最新のものに更新するなど、効果のある場合には、すでにロードされている場合でも 再度ロードすることがあります。
      定義:
        `load` インタフェース内 `Loadable`
      定義:
        `load` インタフェース内 `FieldMapBuilder`
      戻り値:
        インスタンス化と同時にロードするために、thisインスタンスを返します。戻り値は 適切な型にキャストする必要があります。
      例外:
        `IllegalXMLFormatException`
        `java.lang.NumberFormatException`
        `NameNotFoundException`
        `java.awt.image.RasterFormatException`
        `ReflectionClassNotFoundException`

    - #### free

          public XMLFieldMapBuilder free()

      インタフェースからコピーされた説明: `Freeable`
      コンテンツをメモリから破棄出来るようにします. 実際にメモリから破棄されるタイミングは、GCに依存します。
      まだロードされていないか、開放済みのオブジェクトを開放した場合には、通常は何も行いません。
      定義:
        `free` インタフェース内 `Freeable`
      定義:
        `free` インタフェース内 `FieldMapBuilder`
      戻り値:
        デフォルトでロードされる実装を、インスタンス化と同時に開放するためにthisインスタンスを返します。
        戻り値は適切な型にキャストする必要があります。通常、このような実装は効率的でないため推奨されません。

    - #### freeSound

          public XMLFieldMapBuilder freeSound()

      定義:
        `freeSound` インタフェース内 `FieldMapBuilder`

    - #### isLoaded

          public boolean isLoaded()

      インタフェースからコピーされた説明: `Loadable`
      このオブジェクトが、すでにロードされているかを検査します.
      定義:
        `isLoaded` インタフェース内 `Loadable`
      定義:
        `isLoaded` インタフェース内 `FieldMapBuilder`
      戻り値:
        ロード済みである場合はtrueを返します。

    - #### getSoundMap

          public SoundMap getSoundMap()

      定義:
        `getSoundMap` インタフェース内 `FieldMapBuilder`

    - #### setSoundMap

          public void setSoundMap(SoundMap soundMap)

    - #### getNodeMap

          public NodeMap getNodeMap()

      定義:
        `getNodeMap` インタフェース内 `FieldMapBuilder`

    - #### setNodeMap

          public void setNodeMap(NodeMap nodeMap)

    - #### getDataFileReader

          public XMLReader getDataFileReader()

    - #### setDataFileReader

          public void setDataFileReader(XMLReader dataFileReader)

    - #### getChipWidth

          public int getChipWidth()

      定義:
        `getChipWidth` インタフェース内 `FieldMapBuilder`

    - #### getChipHeight

          public int getChipHeight()

      定義:
        `getChipHeight` インタフェース内 `FieldMapBuilder`

    - #### getMessageWindowSprite

          public MessageWindowSprite getMessageWindowSprite()
                                                     throws java.lang.IllegalStateException

      定義:
        `getMessageWindowSprite` インタフェース内 `FieldMapBuilder`
      例外:
        `java.lang.IllegalStateException`

    - #### getTextStorage

          public TextStorage getTextStorage()

      定義:
        `getTextStorage` インタフェース内 `FieldMapBuilder`

    - #### toString

          public java.lang.String toString()

      オーバーライド:
        `toString` クラス内 `java.lang.Object`

    - #### compareTo

          public int compareTo(FieldMapBuilder o)

      定義:
        `compareTo` インタフェース内 `java.lang.Comparable<FieldMapBuilder>`