Package org.web3d.vrml.renderer.ogl.nodes

Class TextureCache

java.lang.Object

org.web3d.vrml.renderer.ogl.nodes.TextureCache

public class TextureCache
extends Object

A cache for Texture instance management where the objects stay according to Java's WeakReference system.

Version:

$Revision: 1.1 $

Author:

Rex Melton

Field Summary

Fields

Modifier and Type	Field	Description
protected static TextureCache	cache	The instance
protected boolean	enabled	Enabled flag
protected HashMap<String,ArrayList<WeakReference<org.j3d.aviatrix3d.Texture>>>	textureMap	The cache map

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextureCache()	Construct a new instance of the empty cache.

Method Summary

Modifier and Type	Method	Description
void	clear()	Clear the cache.
static TextureCache	getInstance()	Return the TextureCache instance
org.j3d.aviatrix3d.Texture	register(String tag, org.j3d.aviatrix3d.Texture texture)	Register a Texture in the cache with the argument id.
org.j3d.aviatrix3d.Texture	register(URL url, org.j3d.aviatrix3d.Texture texture)	Register a Texture in the cache with the argument id.
void	release(String tag, org.j3d.aviatrix3d.Texture texture)	Explicitly remove the Texture from the cache.
void	release(URL url, org.j3d.aviatrix3d.Texture texture)	Explicitly remove the Texture from the cache.
void	setEnabled(boolean enabled)	Set the enabled state of the cache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

textureMap

protected HashMap<String,ArrayList<WeakReference<org.j3d.aviatrix3d.Texture>>> textureMap

The cache map

enabled

protected boolean enabled

Enabled flag

cache

protected static TextureCache cache

The instance

Constructor Details

TextureCache

protected TextureCache()

Construct a new instance of the empty cache.

Method Details

getInstance

public static TextureCache getInstance()

Return the TextureCache instance

Returns:

The TextureCache instance

release

public void release(String tag,
 org.j3d.aviatrix3d.Texture texture)

Explicitly remove the Texture from the cache. If the object has already been freed, this request is silently ignored.

Parameters:

tag - The texture id, typically it's URL string

texture - The Texture to release

release

public void release(URL url,
 org.j3d.aviatrix3d.Texture texture)

Explicitly remove the Texture from the cache. If the object has already been freed, this request is silently ignored.

Parameters:

url - The URL the texture was registered under

texture - The Texture to release

clear

public void clear()

Clear the cache.

setEnabled

public void setEnabled(boolean enabled)

Set the enabled state of the cache

Parameters:

enabled - The enabled state of the cache

register

public org.j3d.aviatrix3d.Texture register(URL url,
 org.j3d.aviatrix3d.Texture texture)

Register a Texture in the cache with the argument id. If the id is null, the argument Texture is not cached and is returned. If a Texture that matches the id and properties of the argument Texture is already in the cache, it will be returned and the argument Texture will not be stored. Otherwise, the argument Texture is stored and is returned.

Parameters:

url - The texture id

texture - The candidate texture to cache

Returns:

The cached Texture

register

public org.j3d.aviatrix3d.Texture register(String tag,
 org.j3d.aviatrix3d.Texture texture)

Register a Texture in the cache with the argument id. If the id is null, the argument Texture is not cached and is returned. If a Texture that matches the id and properties of the argument Texture is already in the cache, it will be returned and the argument Texture will not be stored. Otherwise, the argument Texture is stored and is returned.

Parameters:

tag - The texture id, typically it's URL string

texture - The candidate texture to cache

Returns:

The cached Texture