com.bonzaiengine.model.asset

Class AsyncAsset<T>

java.lang.Object

com.bonzaiengine.model.asset.AsyncAsset<T>

All Implemented Interfaces:

Task.StateChangeListener<T>

Direct Known Subclasses:

AsyncModel, AsyncMotion

public abstract class AsyncAsset<T>
extends java.lang.Object
implements Task.StateChangeListener<T>

Constructor Summary

Constructors

Constructor and Description
AsyncAsset(java.lang.String id, Task<T> loader) AsyncAsset with a custom loading Task
AsyncAsset(T asset, java.lang.String id) Create an AsyncAsset from a T already loaded

Method Summary

Modifier and Type	Method and Description
T	get()
java.lang.String	getID()
T	getIfLoaded()
Task.TaskState	getLoadState()
T	getSync() Deprecated.
boolean	isFailed()
boolean	isLoaded()
boolean	isLoading()
void	onLoad(OnLoadListener<T> listener) Register listeners to receive a one time notification when this asset is loaded.
void	onStateChange(Task<T> task, Task.TaskState state)
T	set(T t)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsyncAsset

public AsyncAsset(T asset,
                  java.lang.String id)

Create an AsyncAsset from a T already loaded

AsyncAsset

public AsyncAsset(java.lang.String id,
                  Task<T> loader)

AsyncAsset with a custom loading Task

Method Detail

getID

public final java.lang.String getID()

Returns:

the identifier the this AsyncAsset

isLoaded

public final boolean isLoaded()

Returns:

true if the asset is loaded an ready to use.

isLoading

public final boolean isLoading()

Returns:

true if an asynchronous Task is working.

isFailed

public final boolean isFailed()

Returns:

true if the asynchronous Task state is failure.

getLoadState

public final Task.TaskState getLoadState()

Returns:

true if the asynchronous Task state is failure.

getIfLoaded

public final T getIfLoaded()

Returns:

the asset if loaded

get

public final T get()

Returns:

the asset if loaded or request asynchronous loading

getSync

@Deprecated
public final T getSync()
                             throws java.io.IOException

Deprecated.

Returns:

wait asynchronous loading is complete or request a synchronous loading, and return the asset

Throws:

java.io.IOException

onStateChange

public final void onStateChange(Task<T> task,
                                Task.TaskState state)

Specified by:

onStateChange in interface Task.StateChangeListener<T>

set

public final T set(T t)

Parameters:

t - asset to set

onLoad

public final void onLoad(OnLoadListener<T> listener)

Register listeners to receive a one time notification when this asset is loaded.

If this asset is already loaded, the notification is send instantly. If this asset is not already loaded, the notification is send inside get() when the loading state is complete.

See Also:

get()