Package io.guise.framework.prototype

Class DefaultMenuToolPrototypeProvisionStrategy

java.lang.Object

java.util.concurrent.locks.ReentrantReadWriteLock

io.guise.framework.prototype.AbstractPrototypeProvisionStrategy

io.guise.framework.prototype.AbstractCompositeComponentPrototypeProvisionStrategy

io.guise.framework.prototype.AbstractMenuToolCompositeComponentPrototypeProvisionStrategy

io.guise.framework.prototype.DefaultMenuToolPrototypeProvisionStrategy

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.locks.ReadWriteLock

public class DefaultMenuToolPrototypeProvisionStrategy
extends AbstractMenuToolCompositeComponentPrototypeProvisionStrategy

The default strategy for keeping track of prototype providers and working with provisioned prototypes, merging them into a menu and/or a toolbar. When the prototype providers change provided prototypes, those provided prototypes are processed. This version monitors the parent composite component children and automatically uses top-level prototype providers added to or removed from the hierarchy. Prototype provisions are not processed initially; this strategy should be initialized after construction by calling AbstractPrototypeProvisionStrategy.processPrototypeProvisions(). This class is thread safe based upon its exposed read and write locks.

Author:

Garret Wilson

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.concurrent.locks.ReentrantReadWriteLock

java.util.concurrent.locks.ReentrantReadWriteLock.ReadLock, java.util.concurrent.locks.ReentrantReadWriteLock.WriteLock

Constructor Summary

Constructors

Constructor	Description
DefaultMenuToolPrototypeProvisionStrategy(CompositeComponent parentComponent, Menu menu, Toolbar toolbar, PrototypeProvider... defaultPrototypeProviders)	Parent component, menu, toolbar, and prototype providers constructor.

Method Summary

Modifier and Type	Method	Description
protected Menu	getMenu()
protected Toolbar	getToolbar()

Methods inherited from class io.guise.framework.prototype.AbstractMenuToolCompositeComponentPrototypeProvisionStrategy

add, getLastComponents, processPrototypeProvisions, synchronizePrototypeProvisionMap

Methods inherited from class io.guise.framework.prototype.AbstractCompositeComponentPrototypeProvisionStrategy

getParentComponent

Methods inherited from class io.guise.framework.prototype.AbstractPrototypeProvisionStrategy

addPrototypeProvider, gatherPrototypeProvisions, getPrototypeProviders, processPrototypeProvisions, removePrototypeProvider

Methods inherited from class java.util.concurrent.locks.ReentrantReadWriteLock

getOwner, getQueuedReaderThreads, getQueuedThreads, getQueuedWriterThreads, getQueueLength, getReadHoldCount, getReadLockCount, getWaitingThreads, getWaitQueueLength, getWriteHoldCount, hasQueuedThread, hasQueuedThreads, hasWaiters, isFair, isWriteLocked, isWriteLockedByCurrentThread, readLock, toString, writeLock

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMenuToolPrototypeProvisionStrategy

public DefaultMenuToolPrototypeProvisionStrategy(CompositeComponent parentComponent,
                                                 Menu menu,
                                                 Toolbar toolbar,
                                                 PrototypeProvider... defaultPrototypeProviders)

Parent component, menu, toolbar, and prototype providers constructor.

Parameters:

parentComponent - The composite component the top-level prototype provider children of which will be monitored.

menu - The menu being managed, or null if no menu is being managed.

toolbar - The toolbar being managed, or null if no toolbar is being managed.

defaultPrototypeProviders - The default prototype providers that will provide prototypes for processing, outside the children of the composite component parent.

Throws:

java.lang.NullPointerException - if the given parent component, prototype providers, and/or one or more prototype provider is null.

Method Detail

getMenu

protected Menu getMenu()

Specified by:

getMenu in class AbstractMenuToolCompositeComponentPrototypeProvisionStrategy

Returns:

The menu being managed, or null if no menu is being managed.

getToolbar

protected Toolbar getToolbar()

Specified by:

getToolbar in class AbstractMenuToolCompositeComponentPrototypeProvisionStrategy

Returns:

The toolbar being managed, or null if no toolbar is being managed.