com.goldencode.p2j.util

Class WidgetPool.WidgetPoolHelper

java.lang.Object

com.goldencode.p2j.util.WidgetPool.WidgetPoolHelper

Enclosing class:

WidgetPool

static class WidgetPool.WidgetPoolHelper
extends java.lang.Object

Helper to expose APIs which have direct access to the context-local state.

Field Summary

Fields

Modifier and Type	Field and Description
private WidgetPool.WorkArea	wa The WidgetPool.WorkArea instance.

Constructor Summary

Constructors

Constructor and Description
WidgetPoolHelper(WidgetPool.WorkArea wa) Create a new instance and associate the given WorkArea instance.

Method Summary

Modifier and Type	Method and Description
void	addResource(WrappedResource resource, character name) Adds the specified resource to the pool.
void	deleteWidgetPools(java.lang.Object proc) Delete all the non-persistent widget-pools associated with the specified procedure.
boolean	hasUnnamedPool(java.lang.Object referent) Checks if the given referent has an unnamed pool registered.
void	removeResource(WrappedResource resource) Remove the given resource from its pool, if it was pooled.
void	scopeFinished(java.lang.Object oThis, boolean external, boolean persistent) Delegates the call to WidgetPool.WorkArea.scopeFinished(Object, boolean, boolean)
void	scopeStart(BlockDefinition block) Delegates the call to WidgetPool.WorkArea.scopeStart(com.goldencode.p2j.util.BlockDefinition)

Methods inherited from class java.lang.Object

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

Field Detail

wa

private final WidgetPool.WorkArea wa

The WidgetPool.WorkArea instance.

Constructor Detail

WidgetPoolHelper

public WidgetPoolHelper(WidgetPool.WorkArea wa)

Create a new instance and associate the given WorkArea instance.

Parameters:

wa - The WidgetPool.WorkArea instance.

Method Detail

addResource

public void addResource(WrappedResource resource,
                        character name)

Adds the specified resource to the pool. Although this is exposed for the public, do not used outside of P2J code. Is made public because access to it is needed from any P2J package.

Parameters:

resource - The resource to be pooled.

name - The pool name, set to null if the unnamed pool is to be used.

Throws:

java.lang.IllegalStateException - The exception is throw if the call of this method targets a named pool (the name parameter is specified) and either the name is unknown or a pool with the specified name does not exist.

If the exception is thrown, there must be an error in the code which creates the resource. That code must validate the pool name (by calling WidgetPool.validWidgetPool(com.goldencode.p2j.util.character)) before any other resource-related validation and before the resource is created.

hasUnnamedPool

public boolean hasUnnamedPool(java.lang.Object referent)

Checks if the given referent has an unnamed pool registered.

Parameters:

referent - The referent to check.

Returns:

true if there is at least one unnamed pool for this referent.

scopeStart

public void scopeStart(BlockDefinition block)

Delegates the call to WidgetPool.WorkArea.scopeStart(com.goldencode.p2j.util.BlockDefinition)

Parameters:

block - The explicit block definition which required this notification.

scopeFinished

public void scopeFinished(java.lang.Object oThis,
                          boolean external,
                          boolean persistent)

Delegates the call to WidgetPool.WorkArea.scopeFinished(Object, boolean, boolean)

removeResource

public void removeResource(WrappedResource resource)

Remove the given resource from its pool, if it was pooled.

Parameters:

resource - The resource to be removed.

deleteWidgetPools

public void deleteWidgetPools(java.lang.Object proc)

Delete all the non-persistent widget-pools associated with the specified procedure.

Parameters:

proc - The external procedure instance.