|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResourceLoader
A resource loader knows how to get binary rawdata from a location specified by an resource key. A resource key is a wrapper around any kind of data that is suitable to identify a resource location. The resource key can also hold configuration data for the factory. If the storage system is hierarchical, a new resource key can be derived from a given path-string.
Method Summary | |
---|---|
ResourceKey |
createKey(Object value,
Map factoryKeys)
Creates a new resource key from the given object and the factory keys. |
ResourceKey |
deriveKey(ResourceKey parent,
String path,
Map factoryKeys)
Derives a new resource key from the given key. |
ResourceKey |
deserialize(ResourceKey bundleKey,
String stringKey)
Creates a ResourceKey based off the String representation
of the key. |
boolean |
isSupportedDeserializer(String data)
Determines if the resource loader is capable of deserializing the serialized version of the ResourceKey. |
boolean |
isSupportedKey(ResourceKey key)
Checks, whether this resource loader implementation was responsible for creating this key. |
ResourceData |
load(ResourceKey key)
Loads the binary data represented by this key. |
String |
serialize(ResourceKey bundleKey,
ResourceKey key)
Serializes the resource key to a String representation which can be recreated using the deserialize(ResourceKey) |
URL |
toURL(ResourceKey key)
Generates a URL version of the supplied ResourceKey . |
Method Detail |
---|
boolean isSupportedKey(ResourceKey key)
key
- the key that should be tested.
ResourceKey createKey(Object value, Map factoryKeys) throws ResourceKeyCreationException
value
- the key value.factoryKeys
- optional parameter map (can be null).
ResourceKeyCreationException
- if creating the key failed.ResourceKey deriveKey(ResourceKey parent, String path, Map factoryKeys) throws ResourceKeyCreationException
parent
- the parentpath
- the derived path (can be null).factoryKeys
- the optional factory keys (can be null).
ResourceKeyCreationException
- if the key cannot be derived for any
reason.ResourceData load(ResourceKey key) throws ResourceLoadingException
key
-
ResourceLoadingException
URL toURL(ResourceKey key)
URL
version of the supplied ResourceKey
.
key
- the ResourceKey
from which a URL
will be created
ResourceKey
boolean isSupportedDeserializer(String data)
data
- the serialized version of the resource key
true
if this ResourceLoader
is capable of deserializing the
serialized version of this resource key, false
otherwise.String serialize(ResourceKey bundleKey, ResourceKey key) throws ResourceException
deserialize(ResourceKey) method.
- Parameters:
bundleKey
- key
-
- Returns:
- a
String which is a serialized version of the ResourceKey
- Throws:
ResourceException
- indicates an error serializing the resource key
ResourceKey deserialize(ResourceKey bundleKey, String stringKey) throws ResourceKeyCreationException
ResourceKey
based off the String
representation
of the key. The String
should have been created using the serialize
method.
bundleKey
- stringKey
- the String
representation of the ResourceKey
@return a ResourceKey
which matches the String
representation
ResourceKeyCreationException
- indicates an error occurred in the creation or
deserialization of the ResourceKey
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |