org.jrabbit.base.sound
Class SoundPointer

java.lang.Object
  extended by org.jrabbit.base.data.cache.CachePointer<SoundData>
      extended by org.jrabbit.base.sound.SoundPointer
All Implemented Interfaces:
Referenced, Retriever<SoundData>

public class SoundPointer
extends CachePointer<SoundData>

An SoundPointer is a CachePointer designed to retrieve SoundData from the default SoundCache in Resources.

Author:
Chris Molini

Field Summary
 
Fields inherited from class org.jrabbit.base.data.cache.CachePointer
object, reference
 
Constructor Summary
SoundPointer(java.lang.String filepath)
          Creates an SoundPointer that will retrieve the indicated SoundData.
 
Method Summary
 SoundData retrieve()
          Accesses the SoundCache and retrieves the associated SoundData.
 
Methods inherited from class org.jrabbit.base.data.cache.CachePointer
object, reference, refresh, setReference, valid
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SoundPointer

public SoundPointer(java.lang.String filepath)
Creates an SoundPointer that will retrieve the indicated SoundData.

Parameters:
reference - A reference that matches that of the SoundData to retrieve from the Cache.
Method Detail

retrieve

public SoundData retrieve()
Accesses the SoundCache and retrieves the associated SoundData.

Returns:
The SoundData in the Cache that has a matching reference with this one.