org.eclipse.stp.core.sca
Interface WireTarget

All Superinterfaces:
SCAObject
All Known Subinterfaces:
ExternalService

public interface WireTarget
extends SCAObject

This interface represents a target for a conceptual wire. A wire is a conceptual mapping of a source element in the model to a target element.

The SCAObject.getName() API will return the target URI to this target.

Use the SCAObject.getFlags() method to get the flags for this target and then you can use the Flags.isBoundaryElement(int) method to determine if the target is a boundary target element.

Boundary elements are EntryPoint and ExternalService elements.

You can obtain a WireSource by using APIs on Composite or Component.

If the element returns true for isComponentOwned() you may cast down to ComponentWireHandle for additional APIs.

This interface is not intended to be implemented by clients.

Since:
1.0
See Also:
WireSource, Component, Service, ExternalService, Composite.resolveWireTarget(String), Component.getWireTarget(Service), Component.getWireTarget(String)

Method Summary
 Interface getInterface()
          Return an Interface that is assigned to this target of a wire.
 boolean isComponentOwned()
          Return true if this WireTarget originates from a Component.
 boolean isResolved()
          Return true if this target was resolved to an element in the SCA model.
 boolean matches(WireSource wireSource)
          NOT IMPLEMENTED.
 
Methods inherited from interface org.eclipse.stp.core.sca.SCAObject
addStatus, clearStatus, getEObject, getFlags, getName, getStatus, setName
 

Method Detail

getInterface

Interface getInterface()
Return an Interface that is assigned to this target of a wire.

Returns:
Interface

matches

boolean matches(WireSource wireSource)
NOT IMPLEMENTED.

Parameters:
wireSource - The wireSource to test for compatibility.
Returns:
True if and only if the Interface of the given wireSource is compatible with this WireTarget.

isResolved

boolean isResolved()
Return true if this target was resolved to an element in the SCA model. If false is returned you can use the SCAObject.getName() method to get the original target URI.

Returns:
boolean

isComponentOwned

boolean isComponentOwned()
Return true if this WireTarget originates from a Component. If this returns true you may cast down to

Returns:
boolean