ResourcesContainer (litiengine 0.5.0 API)

java.lang.Object
- de.gurkenlabs.litiengine.resources.ResourcesContainer<T>

Type Parameters:

T - The type of the resource that is contained by this instance.

Direct Known Subclasses:

Blueprints, Fonts, Images, Maps, Sounds, Tilesets
```
public abstract class ResourcesContainer<T>
extends java.lang.Object
```
An abstract implementation for all classes that provide a certain type of resources. Basically, it's an in-memory cache of the resources and provides access to manage the resources.

See Also:

ResourcesContainerListener

Constructor Summary

Constructors
Constructor and Description

ResourcesContainer()

Constructors
Constructor and Description
`ResourcesContainer()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(java.lang.String resourceName, T resource)` Add the specified resource to this container. The added element can later be retrieved from this container by calling `get(resourceName)`.
`void`	`add(java.net.URL resourceName, T resource)`
`void`	`addClearedListener(ResourcesContainerClearedListener listener)` Add a new container listener to this instance that observes whenever this instance is cleared.
`void`	`addContainerListener(ResourcesContainerListener<? super T> listener)` Add a new container listener to this instance in order to observe resource life cycles.
`void`	`clear()` Clears the resource container by removing all previously loaded resources.
`boolean`	`contains(java.lang.String resourceName)` Checks if this instance contains a resource with the specified name.
`boolean`	`contains(T resource)` Checks if the specified resource is contained by this instance.
`boolean`	`contains(java.net.URL resourceName)`
`int`	`count()` Gets the amount of resources that this container holds.
`java.util.Collection<T>`	`get(java.util.function.Predicate<? super T> pred)` Gets all resources that match the specified condition.
`T`	`get(java.lang.String resourceName)` Gets the resource with the specified name.
`T`	`get(java.lang.String resourceName, boolean forceLoad)` Gets the resource with the specified name.
`T`	`get(java.lang.String resourceName, java.util.function.Supplier<? extends T> loadCallback)` Gets the resource with the specified name.
`T`	`get(java.net.URL resourceName)`
`T`	`get(java.net.URL resourceName, boolean forceLoad)`
`T`	`get(java.net.URL resourceName, java.util.function.Supplier<? extends T> loadCallback)`
`protected java.lang.String`	`getAlias(java.lang.String resourceName, T resource)` Gets an alias for the specified resourceName.
`java.util.Collection<T>`	`getAll()` Gets all loaded resources from this container.
`java.util.concurrent.Future<T>`	`getAsync(java.lang.String name)` Eventually gets the resource with the specified location.
`java.util.concurrent.Future<T>`	`getAsync(java.net.URL location)` Eventually gets the resource with the specified location.
`protected java.util.Map<java.lang.String,T>`	`getResources()`
`protected abstract T`	`load(java.net.URL resourceName)`
`T`	`remove(java.lang.String resourceName)` Removes the resource with the specified name from this container.
`T`	`remove(java.net.URL resourceName)`
`void`	`removeClearedListener(ResourcesContainerClearedListener listener)` Remove the specified listener from this container.
`void`	`removeContainerListener(ResourcesContainerListener<T> listener)` Remove the specified listener from this container.
`java.util.Optional<T>`	`tryGet(java.lang.String resourceName)` Tries to get a resource with the specified name from this container.
`java.util.Optional<T>`	`tryGet(java.net.URL resourceName)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ResourcesContainer
```
public ResourcesContainer()
```
- Method Detail
  - addContainerListener
```
public void addContainerListener(ResourcesContainerListener<? super T> listener)
```
    Add a new container listener to this instance in order to observe resource life cycles. The listener will get notified whenever a resource was added to or removed from this container.
    
    Parameters:
    
    listener - The container listener instance that will receive call backs from this container.
    
    See Also:
    
    removeContainerListener(ResourcesContainerListener)
  - removeContainerListener
```
public void removeContainerListener(ResourcesContainerListener<T> listener)
```
    Remove the specified listener from this container.
    
    Parameters:
    
    listener - The listener instance that was previously added to this container.
    
    See Also:
    
    addContainerListener(ResourcesContainerListener)
  - addClearedListener
```
public void addClearedListener(ResourcesContainerClearedListener listener)
```
    Add a new container listener to this instance that observes whenever this instance is cleared.
    
    Parameters:
    
    listener - The container listener instance.
    
    See Also:
    
    removeClearedListener(ResourcesContainerClearedListener)
  - removeClearedListener
```
public void removeClearedListener(ResourcesContainerClearedListener listener)
```
    Remove the specified listener from this container.
    
    Parameters:
    
    listener - The listener instance that was previously added to this container.
    
    See Also:
    
    addClearedListener(ResourcesContainerClearedListener)
  - add
```
public void add(java.lang.String resourceName,
                T resource)
```
    Add the specified resource to this container.
    The added element can later be retrieved from this container by calling get(resourceName).
    Use this method to make a resource accessible over this container during runtime.
    
    Parameters:
    
    resourceName - The name that the resource is managed by.
    
    resource - The resource instance.
    
    See Also:
    
    get(Predicate), get(String), get(String, boolean), remove(String), tryGet(String)
  - add
```
public void add(java.net.URL resourceName,
                T resource)
```
  - clear
```
public void clear()
```
    Clears the resource container by removing all previously loaded resources.
  - contains
```
public boolean contains(java.lang.String resourceName)
```
    Checks if this instance contains a resource with the specified name.
    Note that the name is not case-sensitive.
    
    Parameters:
    
    resourceName - The resource's name.
    
    Returns:
    
    True if this container contains a resource with the specified name; otherwise false.
    
    See Also:
    
    contains(Object)
  - contains
```
public boolean contains(java.net.URL resourceName)
```
  - contains
```
public boolean contains(T resource)
```
    Checks if the specified resource is contained by this instance.
    
    Parameters:
    
    resource - The resource.
    
    Returns:
    
    True if this instance contains the specified resource instance; otherwise false.
  - count
```
public int count()
```
    Gets the amount of resources that this container holds.
    
    Returns:
    
    The amount of resources in this container.
  - get
```
public java.util.Collection<T> get(java.util.function.Predicate<? super T> pred)
```
    Gets all resources that match the specified condition.
    
    Parameters:
    
    pred - The condition that a resource must fulfill in order to be returned.
    
    Returns:
    
    All resources that match the specified condition.
  - get
```
public T get(java.lang.String resourceName)
```
    Gets the resource with the specified name.
    
    This is the most common (and preferred) way to fetch resources from a container.
    
    If not previously loaded, this method attempts to load the resource on the fly otherwise it will be retrieved from the cache.
    
    Parameters:
    
    resourceName - The resource's name.
    
    Returns:
    
    The resource with the specified name or null if not found.
  - get
```
public T get(java.net.URL resourceName)
```
  - get
```
public T get(java.lang.String resourceName,
             java.util.function.Supplier<? extends T> loadCallback)
```
    Gets the resource with the specified name.
    
    If no such resource is currently present on the container, it will be loaded with the specified loadCallback and added to this container.
    
    Parameters:
    
    resourceName - The resource's name.
    
    loadCallback - The callback that is used to load the resource on-demand if it's not present on this container.
    
    Returns:
    
    T The resource with the specified name.
  - get
```
public T get(java.net.URL resourceName,
             java.util.function.Supplier<? extends T> loadCallback)
```
  - get
```
public T get(java.lang.String resourceName,
             boolean forceLoad)
```
    Gets the resource with the specified name.
    If not previously loaded, this method attempts to load the resource on the fly otherwise it will be retrieved from the cache.
    
    Parameters:
    
    resourceName - The name of the game resource.
    
    forceLoad - If set to true, cached resource (if existing) will be discarded and the resource will be freshly loaded.
    
    Returns:
    
    The game resource or null if not found.
  - get
```
public T get(java.net.URL resourceName,
             boolean forceLoad)
```
  - getAsync
```
public java.util.concurrent.Future<T> getAsync(java.net.URL location)
```
    Eventually gets the resource with the specified location. The resource is loaded asynchronously and can be retrieved from the returned Future object returned by this method once loaded.
    
    Parameters:
    
    location - The location of the resource
    
    Returns:
    
    A Future object that can be used to retrieve the resource once it is finished loading
  - getAsync
```
public java.util.concurrent.Future<T> getAsync(java.lang.String name)
```
    Eventually gets the resource with the specified location. The resource is loaded asynchronously and can be retrieved from the returned Future object returned by this method once loaded.
    
    Parameters:
    
    name - The name or location of the resource
    
    Returns:
    
    A Future object that can be used to retrieve the resource once it is finished loading
  - getAll
```
public java.util.Collection<T> getAll()
```
    Gets all loaded resources from this container.
    
    Returns:
    
    All loaded resources.
  - remove
```
public T remove(java.lang.String resourceName)
```
    Removes the resource with the specified name from this container.
    
    Parameters:
    
    resourceName - The name of the resource that should be removed.
    
    Returns:
    
    The removed resource.
  - remove
```
public T remove(java.net.URL resourceName)
```
  - tryGet
```
public java.util.Optional<T> tryGet(java.lang.String resourceName)
```
    Tries to get a resource with the specified name from this container.
    This method should be used, if it's not clear whether the resource is present on this container.
    It is basically a combination of get(String) and contains(String) and allows to check whether a resource is present while also fetching it from the container.
    
    Parameters:
    
    resourceName - The name of the resource.
    
    Returns:
    
    An Optional instance that holds the resource instance, if present on this container.
    
    See Also:
    
    Optional, contains(String), get(String)
  - tryGet
```
public java.util.Optional<T> tryGet(java.net.URL resourceName)
```
  - load
```
protected abstract T load(java.net.URL resourceName)
                   throws java.lang.Exception
```
    Throws:
    
    java.lang.Exception
  - getAlias
```
protected java.lang.String getAlias(java.lang.String resourceName,
                                    T resource)
```
    Gets an alias for the specified resourceName. Note that the process of providing an alias is up to the ResourceContainer implementation.
    
    Parameters:
    
    resourceName - The original name of the resource.
    
    resource - The resource.
    
    Returns:
    
    An alias for the specified resource.
  - getResources
```
protected java.util.Map<java.lang.String,T> getResources()
```

Class ResourcesContainer<T>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ResourcesContainer

Method Detail

addContainerListener

removeContainerListener

addClearedListener

removeClearedListener

add

add

clear

contains

contains

contains

count

get

get

get

get

get

get

get

getAsync

getAsync

getAll

remove

remove

tryGet

tryGet

load

getAlias

getResources