griffon.core.resources

Interface ResourceHandler

All Known Subinterfaces:

GriffonArtifact, GriffonController, GriffonModel, GriffonMvcArtifact, GriffonService, GriffonView

All Known Implementing Classes:

AbstractGriffonArtifact, AbstractGriffonArtifactScript, AbstractGriffonController, AbstractGriffonModel, AbstractGriffonMvcArtifact, AbstractGriffonMvcArtifactScript, AbstractGriffonService, AbstractGriffonView, AbstractGriffonViewScript, AbstractJavaFXGriffonView, AbstractLanternaGriffonView, AbstractPivotGriffonView, AbstractResourceHandler, AbstractSwingGriffonView, DefaultResourceHandler

public interface ResourceHandler

Indicates a type that knows how to load resources from the classpath.

Since:

2.0.0

Author:

Andres Almiray

Method Summary

Methods

Modifier and Type	Method and Description
ClassLoader	classloader() Returns the classloader used to resolve resources.
InputStream	getResourceAsStream(String name) Returns an input stream for reading the specified resource.
URL	getResourceAsURL(String name) Finds the resource with the given name.
List<URL>	getResources(String name) Finds all the resources with the given name.

Method Detail

getResourceAsURL

@Nullable
URL getResourceAsURL(@Nonnull
                            String name)

Finds the resource with the given name. A resource is some data (images, audio, text, etc) that can be accessed by class code in a way that is independent of the location of the code.

The name of a resource is a '/'-separated path name that identifies the resource.

Parameters:

name - The resource name

Returns:

A URL object for reading the resource, or null if the resource could not be found.

getResourceAsStream

@Nullable
InputStream getResourceAsStream(@Nonnull
                                       String name)

Returns an input stream for reading the specified resource.

Parameters:

name - The resource name

Returns:

An input stream for reading the resource, or null if the resource could not be found

getResources

@Nullable
List<URL> getResources(@Nonnull
                              String name)

Finds all the resources with the given name. A resource is some data (images, audio, text, etc) that can be accessed by class code in a way that is independent of the location of the code.

The name of a resource is a /-separated path name that identifies the resource.

Parameters:

name - The resource name

Returns:

An java.util.List of URL objects for the resource. If no resources could be found, the list will be empty. Resources that the class loader doesn't have access to will not be in the list.

classloader

@Nonnull
ClassLoader classloader()

Returns the classloader used to resolve resources.

Returns:

a classloader instance