org.eclipse.kura.wire

Class WireConfiguration

java.lang.Object

org.eclipse.kura.wire.WireConfiguration

Direct Known Subclasses:

MultiportWireConfiguration

@NotThreadSafe
 @ProviderType
public class WireConfiguration
extends java.lang.Object

The Class WireConfiguration represents a wiring configuration between a Wire Emitter and a Wire Receiver. In a Wire Graph in Kura Wires, the connection that connect two different Wire Components is known as WireConfiguration.

Two WireConfigurations with equal Emitter PID and Receiver PID are considered to be equal WireConfiguration instances and it is validated through its equals(Object) and hashCode() methods' contract and hence, it is suitable to be used with hash based collections.

Since:

1.2

See Also:

Wire

Constructor Summary

Constructors

Constructor and Description
WireConfiguration(java.lang.String emitterPid, java.lang.String receiverPid) Instantiates a new WireConfiguration.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEmitterPid() Gets the Wire Emitter PID.
java.lang.String	getFilter() Gets the associated filter.
java.lang.String	getReceiverPid() Gets the Wire Receiver PID.
org.osgi.service.wireadmin.Wire	getWire() Gets the associated WireAdmin' Wire instance.
int	hashCode()
void	setFilter(java.lang.String filter) Sets the filter for this WireConfiguration
void	setWire(org.osgi.service.wireadmin.Wire wire) Sets the Wire instance.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WireConfiguration

public WireConfiguration(java.lang.String emitterPid,
                         java.lang.String receiverPid)

Instantiates a new WireConfiguration.

Parameters:

emitterPid - the Wire Emitter PID

receiverPid - the Wire Receiver PID

Throws:

java.lang.NullPointerException - if any of the arguments is null

Method Detail

getEmitterPid

public java.lang.String getEmitterPid()

Gets the Wire Emitter PID.

Returns:

the Wire Emitter PID

getFilter

public java.lang.String getFilter()

Gets the associated filter.

Returns:

the filter

getReceiverPid

public java.lang.String getReceiverPid()

Gets the Wire Receiver PID.

Returns:

the Wire Receiver PID

getWire

public org.osgi.service.wireadmin.Wire getWire()

Gets the associated WireAdmin' Wire instance.

Returns:

the Wire instance

setFilter

public void setFilter(java.lang.String filter)

Sets the filter for this WireConfiguration

Parameters:

filter - the new filter

setWire

public void setWire(org.osgi.service.wireadmin.Wire wire)

Sets the Wire instance.

Parameters:

wire - the new Wire instance

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object