com.bonzaiengine.model.asset

Class AssetLibrary<Key,Asset>

java.lang.Object

com.bonzaiengine.model.asset.AssetLibrary<Key,Asset>

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<Key,Asset>>

Direct Known Subclasses:

AnimGraphLibrary, MaterialGraphLibrary, MaterialLibrary, ModelLibrary, MotionLibrary, SplineLibrary, TextureLibrary

public abstract class AssetLibrary<Key,Asset>
extends java.lang.Object
implements java.lang.Iterable<java.util.Map.Entry<Key,Asset>>

Abstract asset library.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<Key,Asset>	entries

Constructor Summary

Constructors

Modifier	Constructor and Description
	AssetLibrary(boolean concurrent)
protected	AssetLibrary(boolean concurrent, boolean soft) Constructor using the specified map for internal storage

Method Summary

Modifier and Type	Method and Description
void	add(Key assetKey, Asset asset) Add an asset to the library.
java.lang.Iterable<Asset>	assets()
void	clear()
boolean	contains(Key assetKey)
Asset	get(Key key) Request an asset from its key
Key	getKey(Asset asset) Find the key associated to the asset
Asset	getOrCreate(Key key, java.util.function.Supplier<Asset> creator) Request an asset from its key
java.util.Iterator<java.util.Map.Entry<Key,Asset>>	iterator()
Asset	remove(Key assetKey)
Key	removeValue(Asset asset)
int	size()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

entries

protected final java.util.Map<Key,Asset> entries

Constructor Detail

AssetLibrary

public AssetLibrary(boolean concurrent)

Parameters:

concurrent - true to use a concurrent collection

AssetLibrary

protected AssetLibrary(boolean concurrent,
                       boolean soft)

Constructor using the specified map for internal storage

Method Detail

add

public void add(Key assetKey,
                Asset asset)
         throws java.lang.IllegalArgumentException

Add an asset to the library.

Parameters:

asset - asset to store in the library

assetKey - asset key, usually the loading information

Throws:

java.lang.IllegalArgumentException - when the asset is already in the library

get

public final Asset get(Key key)

Request an asset from its key

Parameters:

key - asset key

Returns:

the asset, or null if not found

getOrCreate

public final Asset getOrCreate(Key key,
                               java.util.function.Supplier<Asset> creator)

Request an asset from its key

Parameters:

key - asset key

Returns:

the asset, or null if not found

getKey

public final Key getKey(Asset asset)

Find the key associated to the asset

Parameters:

asset - asset to find

Returns:

the asset key, or null if not found

remove

public final Asset remove(Key assetKey)

Parameters:

assetKey - the asset key to remove

Returns:

the asset removed, null if nothing removed

removeValue

public final Key removeValue(Asset asset)

Parameters:

asset - the asset to remove

Returns:

the asset removed, null if nothing removed

clear

public void clear()

contains

public final boolean contains(Key assetKey)

Returns:

true if the library contains the asset key

size

public final int size()

Returns:

the number of asset in this library

iterator

public final java.util.Iterator<java.util.Map.Entry<Key,Asset>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<Key,Asset>>

assets

public final java.lang.Iterable<Asset> assets()