Package com.iizix.gyro
Interface IRuntimeImageCache
- All Known Subinterfaces:
IAppSessionGyro
,IClientSessionGyro
,IRuntimeImageCacheImpl
- All Known Implementing Classes:
AppSessionGyro
,ClientSessionGyro
public interface IRuntimeImageCache
The runtime image cache interface.- Author:
- Christopher Mindus
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
clearImageCache()
Clears the entire cache or theIRuntimeImageCache
cache implementor, e.g.RuntimeImageDefinition
getImage(java.lang.String name)
Gets an image definition from the image container of theIRuntimeImageCache
cache implementor, e.g.boolean
removeImage(java.lang.String name)
Removes an image with a name from the cache of theIRuntimeImageCache
cache implementor, e.g.boolean
setImage(RuntimeImageDefinition image)
Adds the image definition to the image container for theIRuntimeImageCache
cache implementor, e.g.
Method Detail
getImage
RuntimeImageDefinition getImage(java.lang.String name)
Gets an image definition from the image container of theIRuntimeImageCache
cache implementor, e.g. Client session or Application Session.- Parameters:
name
- The image name.- Returns:
- The predefined image definition, or null if not found.
setImage
boolean setImage(RuntimeImageDefinition image)
Adds the image definition to the image container for theIRuntimeImageCache
cache implementor, e.g. Client session or Application Session. If the image already exists, it is replaced with the new definition.- Parameters:
image
- The image definition.- Returns:
- true if the container was changed, i.e. image was added or replaced, false for no change.
removeImage
boolean removeImage(java.lang.String name)
Removes an image with a name from the cache of theIRuntimeImageCache
cache implementor, e.g. Client session or Application Session.- Parameters:
name
- The image to remove.- Returns:
- true for removed, false if not found.
clearImageCache
void clearImageCache()
Clears the entire cache or theIRuntimeImageCache
cache implementor, e.g. Client session or Application Session.