Package org.pipservices3.container.refer

Class ReferencesDecorator

java.lang.Object

org.pipservices3.container.refer.ReferencesDecorator

All Implemented Interfaces:

org.pipservices3.commons.refer.IReferences

Direct Known Subclasses:

BuildReferencesDecorator, LinkReferencesDecorator, ManagedReferences, RunReferencesDecorator

public class ReferencesDecorator
extends Object
implements org.pipservices3.commons.refer.IReferences

Chainable decorator for IReferences that allows to inject additional capabilities such as automatic component creation, automatic registration and opening.

See Also:

• IReferences

Constructor Summary

Constructors

Constructor	Description
ReferencesDecorator()	Creates a new instance of the decorator.
ReferencesDecorator(org.pipservices3.commons.refer.IReferences baseReferences)	Creates a new instance of the decorator.
ReferencesDecorator(org.pipservices3.commons.refer.IReferences nextReferences, org.pipservices3.commons.refer.IReferences topReferences)	Creates a new instance of the decorator.

Method Summary

Modifier and Type	Method	Description
<T> List<T>	find(Class<T> type, Object locator, boolean required)	Gets all component references that match specified locator.
List<Object>	find(Object locator, boolean required)	Gets all component references that match specified locator.
List<Object>	getAll()	Gets all component references registered in this reference map.
List<Object>	getAllLocators()	Gets locators for all registered component references in this reference map.
org.pipservices3.commons.refer.IReferences	getNextReferences()
<T> T	getOneOptional(Class<T> type, Object locator)	Gets an optional component reference that matches specified locator.
Object	getOneOptional(Object locator)	Gets an optional component reference that matches specified locator.
<T> T	getOneRequired(Class<T> type, Object locator)	Gets a required component reference that matches specified locator.
Object	getOneRequired(Object locator)	Gets a required component reference that matches specified locator.
<T> List<T>	getOptional(Class<T> type, Object locator)	Gets all component references that match specified locator.
List<Object>	getOptional(Object locator)	Gets all component references that match specified locator.
<T> List<T>	getRequired(Class<T> type, Object locator)	Gets all component references that match specified locator.
List<Object>	getRequired(Object locator)	Gets all component references that match specified locator.
org.pipservices3.commons.refer.IReferences	getTopReferences()
void	put(Object locator, Object component)	Puts a new reference into this reference map.
Object	remove(Object locator)	Removes a previously added reference that matches specified locator.
List<Object>	removeAll(Object locator)	Removes all component references that match the specified locator.
void	setNextReferences(org.pipservices3.commons.refer.IReferences value)
void	setTopReferences(org.pipservices3.commons.refer.IReferences value)

Methods inherited from class java.lang.Object

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

Constructor Details

ReferencesDecorator

public ReferencesDecorator()

Creates a new instance of the decorator.

ReferencesDecorator

public ReferencesDecorator(org.pipservices3.commons.refer.IReferences baseReferences)

Creates a new instance of the decorator.

Parameters:

baseReferences - the next references or decorator in the chain.

ReferencesDecorator

public ReferencesDecorator(org.pipservices3.commons.refer.IReferences nextReferences,
 org.pipservices3.commons.refer.IReferences topReferences)

Creates a new instance of the decorator.

Parameters:

nextReferences - the next references or decorator in the chain.

topReferences - the decorator at the top of the chain.

Method Details

getNextReferences

public org.pipservices3.commons.refer.IReferences getNextReferences()

setNextReferences

public void setNextReferences(org.pipservices3.commons.refer.IReferences value)

getTopReferences

public org.pipservices3.commons.refer.IReferences getTopReferences()

setTopReferences

public void setTopReferences(org.pipservices3.commons.refer.IReferences value)

put

public void put(Object locator,
 Object component)
         throws org.pipservices3.commons.errors.ApplicationException

Puts a new reference into this reference map.

Specified by:

put in interface org.pipservices3.commons.refer.IReferences

Parameters:

locator - a locator to find the reference by.

component - a component reference to be added.

Throws:

org.pipservices3.commons.errors.ApplicationException - when error occured.

remove

public Object remove(Object locator)
              throws org.pipservices3.commons.errors.ApplicationException

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

Specified by:

remove in interface org.pipservices3.commons.refer.IReferences

Parameters:

locator - a locator to remove reference

Returns:

the removed component reference.

Throws:

org.pipservices3.commons.errors.ApplicationException

See Also:

• removeAll(Object)

removeAll

public List<Object> removeAll(Object locator)
                       throws org.pipservices3.commons.errors.ApplicationException

Removes all component references that match the specified locator.

Specified by:

removeAll in interface org.pipservices3.commons.refer.IReferences

Parameters:

locator - the locator to remove references by.

Returns:

a list, containing all removed references.

Throws:

org.pipservices3.commons.errors.ApplicationException

getAll

public List<Object> getAll()

Gets all component references registered in this reference map.

Specified by:

getAll in interface org.pipservices3.commons.refer.IReferences

Returns:

a list with component references.

getAllLocators

public List<Object> getAllLocators()

Gets locators for all registered component references in this reference map.

Specified by:

getAllLocators in interface org.pipservices3.commons.refer.IReferences

Returns:

a list with component locators.

getOneOptional

public Object getOneOptional(Object locator)

Gets an optional component reference that matches specified locator.

Specified by:

getOneOptional in interface org.pipservices3.commons.refer.IReferences

Parameters:

locator - the locator to find references by.

Returns:

a matching component reference or null if nothing was found.

getOneOptional

public <T> T getOneOptional(Class<T> type,
 Object locator)

Gets an optional component reference that matches specified locator.

Specified by:

getOneOptional in interface org.pipservices3.commons.refer.IReferences

Parameters:

type - the class type.

locator - the locator to find references by.

Returns:

a matching component reference or null if nothing was found.

getOneRequired

public Object getOneRequired(Object locator)
                      throws org.pipservices3.commons.refer.ReferenceException

Gets a required component reference that matches specified locator.

Specified by:

getOneRequired in interface org.pipservices3.commons.refer.IReferences

Parameters:

locator - the locator to find a reference by.

Returns:

a matching component reference.

Throws:

org.pipservices3.commons.refer.ReferenceException - when no references found.

getOneRequired

public <T> T getOneRequired(Class<T> type,
 Object locator)
                     throws org.pipservices3.commons.refer.ReferenceException

Gets a required component reference that matches specified locator.

Specified by:

getOneRequired in interface org.pipservices3.commons.refer.IReferences

Parameters:

type - the class type.

locator - the locator to find a reference by.

Returns:

a matching component reference.

Throws:

org.pipservices3.commons.refer.ReferenceException - when no references found.

getOptional

public List<Object> getOptional(Object locator)

Gets all component references that match specified locator.

Specified by:

getOptional in interface org.pipservices3.commons.refer.IReferences

Parameters:

locator - the locator to find references by.

Returns:

a list with matching component references or empty list if nothing was found.

getOptional

public <T> List<T> getOptional(Class<T> type,
 Object locator)

Gets all component references that match specified locator.

Specified by:

getOptional in interface org.pipservices3.commons.refer.IReferences

Parameters:

type - the class type

locator - the locator to find references by.

Returns:

a list with matching component references or empty list if nothing was found.

getRequired

public List<Object> getRequired(Object locator)
                         throws org.pipservices3.commons.refer.ReferenceException

Gets all component references that match specified locator. At least one component reference must be present. If it doesn't the method throws an error.

Specified by:

getRequired in interface org.pipservices3.commons.refer.IReferences

Parameters:

locator - the locator to find references by.

Returns:

a list with matching component references.

Throws:

org.pipservices3.commons.refer.ReferenceException - when no references found.

getRequired

public <T> List<T> getRequired(Class<T> type,
 Object locator)
                        throws org.pipservices3.commons.refer.ReferenceException

Gets all component references that match specified locator. At least one component reference must be present. If it doesn't the method throws an error.

Specified by:

getRequired in interface org.pipservices3.commons.refer.IReferences

Parameters:

type - the class type.

locator - the locator to find references by.

Returns:

a list with matching component references.

Throws:

org.pipservices3.commons.refer.ReferenceException - when no references found.

find

public List<Object> find(Object locator,
 boolean required)
                  throws org.pipservices3.commons.refer.ReferenceException

Gets all component references that match specified locator.

Specified by:

find in interface org.pipservices3.commons.refer.IReferences

Parameters:

locator - the locator to find a reference by.

required - forces to raise an exception if no reference is found.

Returns:

a list with matching component references.

Throws:

org.pipservices3.commons.refer.ReferenceException - when required is set to true but no references found.

find

public <T> List<T> find(Class<T> type,
 Object locator,
 boolean required)
                 throws org.pipservices3.commons.refer.ReferenceException

Gets all component references that match specified locator.

Specified by:

find in interface org.pipservices3.commons.refer.IReferences

Parameters:

type - the class type.

locator - the locator to find a reference by.

required - forces to raise an exception if no reference is found.

Returns:

a list with matching component references.

Throws:

org.pipservices3.commons.refer.ReferenceException - when required is set to true but no references found.