    All Packages  Class Hierarchy  This Package  Previous  Next  Index

# Interface org.w3c.tools.resources.ResourceReference

public interface ResourceReference

Resolving a resource provides back a resource reference. Resource references are the basis for handling an eventual cache between the store of the resource and its memory image (ie the resource instance).

All resource spaces must provide some notion of resource reference.

A typical access to a resource looks like:

     ResourceReference rr = space.lookup("/x/y/z");
     try {
        Resource r = rr.lock();
        // Fiddle with the resource:
        r.setValue("foo", new Integer(10));
     } catch (InvalidResourceException e) {
       System.out.println(e.getMessage());
     } finally {
        // Make sure to unlock the reference:
        rr.unlock();

##

isLocked()
  Is that resource reference locked ?
lock()
  Lock the refered resource in memory.
nbLock()
  How many locks?
unlock()
  Unlock that resource from memory.
updateContext(ResourceContext)
  update the cached context of that reference.

##

lock

     public abstract Resource lock() throws InvalidResourceException

  Lock the refered resource in memory.

  Returns:
    A real pointer to the resource.
  Throws: InvalidResourceException
    is thrown if the resource is invalid (has been deleted or everything else).

unlock

     public abstract void unlock()

  Unlock that resource from memory.

isLocked

     public abstract boolean isLocked()

  Is that resource reference locked ?

  Returns:
    a boolean.

nbLock

     public abstract int nbLock()

  How many locks?

  Returns:
    an int.

updateContext

     public abstract void updateContext(ResourceContext ctxt)

  update the cached context of that reference.

  Parameters:
    ctxt - the new ResourceContext.

    All Packages  Class Hierarchy  This Package  Previous  Next  Index