kinugasa.field
インタフェース FieldMapBuilder

すべてのスーパーインタフェース:
Freeable, Nameable
既知の実装クラスの一覧:
XMLFieldMapBuilder

public interface FieldMapBuilder
extends Freeable, Nameable

フィールドマップとその関連データをロードし、構築する機能を定義します.

バージョン:
1.0.0 - 2013/05/05_0:09:15
作成者:
Dra0211

メソッドの概要
 XMLFieldMapBuilder free()
          コンテンツをメモリから破棄出来るようにします.
 int getChipHeight()
           
 int getChipWidth()
           
 FieldMap getFieldMap()
           
 java.lang.String getName()
          このインスタンスの一意的な名前を取得します.
 NodeMap getNodeMap()
           
 SoundMap getSoundMap()
           
 boolean isLoaded()
          このオブジェクトが、すでにロードされているかを検査します.
 XMLFieldMapBuilder load()
          コンテンツをロードして展開します.
 

メソッドの詳細

getName

java.lang.String getName()
インタフェース Nameable の記述:
このインスタンスの一意的な名前を取得します. 名前はゲームの実行中変更されてはなりません。

定義:
インタフェース Nameable 内の getName
戻り値:
このインスタンスを識別できる一意的な名前を返します。名前はユーザやプレイヤーが指定する可能性があるため 意味のある文字列を推奨します。

getFieldMap

FieldMap getFieldMap()
                     throws NotYetLoadedException
例外:
NotYetLoadedException

getChipHeight

int getChipHeight()

getChipWidth

int getChipWidth()

getNodeMap

NodeMap getNodeMap()

getSoundMap

SoundMap getSoundMap()

load

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

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

free

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

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

isLoaded

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

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