Package org.appng.api.model

Interface Resources

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

ApplicationResourceHolder

public interface Resources
extends Closeable

A container providing easy access to the a Applications multiple Resources.

Author:

Matthias Müller

See Also:

Resource, Application

Method Summary

Modifier and Type	Method	Description
void	close()
void	dumpToCache(ResourceType... types)	Writes all Resources to the local caching location.
ApplicationInfo	getApplicationInfo()	Returns the ApplicationInfo, read from the Application's application-info.xml.
Resource	getResource(Integer id)	Returns the Resource with the given ID.
Resource	getResource(ResourceType type, String fileName)	Returns the Resource of the given type with the given name, if any.
Set<Resource>	getResources()	Returns the underlying Resource
Set<Resource>	getResources(ResourceType type)	Returns all Resources of the given ResourceType.

Method Detail

getResources

Set<Resource> getResources(ResourceType type)

Returns all Resources of the given ResourceType.

Parameters:

type - the ResourceType

Returns:

the Resources of the given ResourceType

dumpToCache

void dumpToCache(ResourceType... types)

Writes all Resources to the local caching location.

Parameters:

types - the types to write the cachefiles for

See Also:

Resource.getCachedFile()

getResource

Resource getResource(ResourceType type,
                     String fileName)

Returns the Resource of the given type with the given name, if any.

Parameters:

type - the ResourceType of the Resource

fileName - the name of the Resource

Returns:

the Resource, or null if no such Resource exists.

getResources

Set<Resource> getResources()

Returns the underlying Resource

Returns:

the underlying Resources

getResource

Resource getResource(Integer id)

Returns the Resource with the given ID.

Parameters:

id - the ID of the Resource

Returns:

the Resource, or null if no such resource exists.

getApplicationInfo

ApplicationInfo getApplicationInfo()

Returns the ApplicationInfo, read from the Application's application-info.xml.

Returns:

the ApplicationInfo

close

void close()
    throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException