|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Plug
Plug is virtual one-sided (local) interface between Piece
's inside
and its outside - it defines possibility of (and conditions for) connecting Channel
s
to the Piece
object.
Piece
,
Channel
,
BasicPlug
Method Summary | |
---|---|
void |
connectChannel(Channel channel)
Connects the Channel in the associated Piece . |
boolean |
disconnectChannel()
Disconnects the associated channel. |
java.lang.Object |
getInputInterface()
Returns the internal (implemented) interface object - to be called from outside. |
java.lang.String |
getInputInterfaceName()
Returns the fully-qualified name of an internal (implemented) interface - to be called from outside. |
java.lang.String |
getKey()
Gets the access key from associated Template to this Plug. |
java.lang.String |
getOutputInterfaceName()
Returns the fully-qualified name of an external (required) interface - to be called from this Piece . |
Piece |
getPiece()
Gets the associated Piece . |
Template |
getTemplate()
Gets the associated Template . |
boolean |
isCloneable()
Can this Plug be cloned? |
boolean |
isCompatible(Plug pl)
Compatibility test: Am I compatible with the given Plug? |
boolean |
isCompatible(java.lang.String iInterface,
java.lang.String oInterface,
boolean cl,
boolean mul)
Compatibility test: Am I compatible with the given parameters? |
boolean |
isInput()
Has this Plug the input capability (can be called from outside)? |
boolean |
isMandatory()
Is this Plug mandatory? |
boolean |
isMulti()
Can this Plug be used in multi-channels? |
boolean |
isOpposite(Plug opposite)
Compatibility test: Am I compatible with the opposite Plug? |
boolean |
isOutput()
Has this Plug the output capability (can call other interfaces)? |
Method Detail |
---|
boolean isInput()
getInputInterfaceName()
,
getInputInterface()
boolean isOutput()
getOutputInterfaceName()
boolean isMandatory()
boolean isMulti()
boolean isCloneable()
getKey()
java.lang.String getInputInterfaceName()
isInput()
java.lang.String getOutputInterfaceName()
Piece
.
isOutput()
java.lang.Object getInputInterface()
Template getTemplate()
Template
. For topological purposes only.
Template
or null.getKey()
,
getPiece()
Piece getPiece()
Piece
. For topological purposes only.
Piece
or null.getKey()
,
getTemplate()
java.lang.String getKey()
Template
to this Plug.
For topological purposes only.
getTemplate()
boolean isCompatible(java.lang.String iInterface, java.lang.String oInterface, boolean cl, boolean mul)
iInterface
- Required input interface (or null).oInterface
- Required output interface (or null).cl
- Is the cloneability required?.mul
- Is the multi-channel property required?.
boolean isCompatible(Plug pl)
pl
- The checked Plug.
boolean isOpposite(Plug opposite)
opposite
- The opposite Plug.
void connectChannel(Channel channel)
Channel
in the associated Piece
.
channel
- The Channel
to be connected to this Plug.boolean disconnectChannel()
Channel
connected.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |