Package de.pirckheimer_gymnasium.engine_pi.resources

Class ResourcesContainer<T>

java.lang.Object
de.pirckheimer_gymnasium.engine_pi.resources.ResourcesContainer<T>
Type Parameters:
T - Der Datentyp der Ressource, die in dieser Instanz enthalten ist.
Direct Known Subclasses:
ImagesContainer, SoundsContainer
public abstract class ResourcesContainer<T> extends Object
Eine abstrakte Implementierung für Unterklassen, die einen bestimmten Typ von Ressourcen (z. b. Bilder, Klänge) bereitstellen wollen. Diese Klasse bietet Methoden zur Verwalten der Ressourcen an. Die Ressourcen werden von dieser Klasse im Speicher gehalten. Es handelt sich also um einen Cache.
See Also:

  • Constructor Details

    • ResourcesContainer

      public ResourcesContainer()

  • Method Details

    • addContainerListener

      public ResourcesContainerListener<T> addContainerListener(ResourcesContainerListener<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

      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:

    • 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

      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:

    • addManipulator

      public void addManipulator(ResourceManipulator<T> manipulator)
      Fügt einen Resourcenmanipulator zu diesem Resourcenspeicher hinzu.

    • removeManipulator

      public void removeManipulator()
      Entfernt den Resourcenmanipulator aus diesem Resourcenspeicher.

    • add

      public T add(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:

    • add

      public T add(URL resourceName, T resource)

    • clear

      public void clear()
      Clears the resource container by removing all previously loaded resources.

    • contains

      public boolean contains(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

      public boolean contains(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 Collection<T> get(Predicate<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(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(URL resourceName)

    • get

      public T get(String resourceName, 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(URL resourceName, Supplier<? extends T> loadCallback)

    • get

      public T get(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(URL resourceName, boolean forceLoad)

    • getAsync

      public Future<T> getAsync(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 Future<T> getAsync(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 Collection<T> getAll()
      Gets all loaded resources from this container.
      Returns:
      All loaded resources.

    • remove

      public T remove(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(URL resourceName)

    • tryGet

      public Optional<T> tryGet(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:

    • tryGet

      public Optional<T> tryGet(URL resourceName)

    • load

      protected abstract T load(URL resourceName) throws Exception
      Throws:
      Exception

    • getAlias

      protected String getAlias(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 Map<String,T> getResources()