Pip-Services-Commons-Dotnet
Public Member Functions | Private Attributes | List of all members
PipServices3.Commons.Refer.Reference Class Reference

Contains a reference to a component and locator to find it. It is used by References to store registered component references. More...

Public Member Functions

 Reference (object locator, object component)
 Create a new instance of the reference object and assigns its values. More...
 
bool Match (object locator)
 Matches locator to this reference locator. More...
 
object GetComponent ()
 Gets the stored component reference. More...
 
object GetLocator ()
 Gets the stored component locator. More...
 

Private Attributes

object _locator
 
object _component
 

Detailed Description

Contains a reference to a component and locator to find it. It is used by References to store registered component references.

Constructor & Destructor Documentation

◆ Reference()

PipServices3.Commons.Refer.Reference.Reference ( object  locator,
object  component 
)

Create a new instance of the reference object and assigns its values.

Parameters
locatora locator to find the reference.
componenta reference to component.

Member Function Documentation

◆ GetComponent()

object PipServices3.Commons.Refer.Reference.GetComponent ( )

Gets the stored component reference.

Returns
the component's references.

◆ GetLocator()

object PipServices3.Commons.Refer.Reference.GetLocator ( )

Gets the stored component locator.

Returns
the component's locator.

◆ Match()

bool PipServices3.Commons.Refer.Reference.Match ( object  locator)

Matches locator to this reference locator.

Descriptors are matched using equal method.All other locator types are matched using direct comparison.

Parameters
locatorthe locator to match.
Returns
true if locators are matching and false it they don't.

The documentation for this class was generated from the following file: