LinkReferencesDecorator

Extends: ReferencesDecorator

Implements: IOpenable

Description

The LinkReferencesDecorator class allows you to create a references decorator that automatically sets references to newly added components that implement the IReferenceable interface, and unsets references from removed components that implement the IUnreferenceable interface.

Constructors

Creates a new instance of the decorator.

public public LinkReferencesDecorator(IReferences nextReferences, IReferences topReferences)

• nextReferences: IReferences - next references or decorator in the chain.
• topReferences: IReferences - decorator at the top of the chain.

Instance methods

close

Closes the component and frees used resources.

public void close(IContext context) throws ApplicationException

• context: IContext - (optional) a context to trace execution through a call chain.

isOpen

Checks if the component is open.

public boolean isOpen()

• returns: boolean - True if the component is open and False otherwise.

open

Opens the component.

public void open(IContext context) throws ApplicationException

• context: IContext - (optional) a context to trace execution through a call chain.

put

Puts a new reference into the reference map.

public void put(Object locator, Object component) throws ApplicationException

• locator: Object - locator to find the reference by.
• component: Object - component’s reference to be added.

remove

Removes a previously added reference that matches the specified locator. If many references match the locator, it removes only the first one. When all references shall be removed, use removeAll method instead.

public Object remove(Object locator) throws ApplicationException

• locator: Object - locator to remove reference
• returns: Object - removed component reference.

removeAll

Removes all component references that match the specified locator.

public List