org.objectweb.fractal.api.type
Interface InterfaceType
- Type
public interface InterfaceType
A component interface type. Such a type is made of a name, which is the name
of the interface described by this type inside its component (see
getFcItfName
), a list of
method signatures, which describes the methods provided or required by this
interface, and various flags that indicates if this interface is provided or
required, mandatory or not...
String | getFcItfName() - Returns the name of component interfaces of this type.
|
String | getFcItfSignature() - Returns the signatures of the methods of interfaces of this type.
|
boolean | isFcClientItf() - Returns true if component interfaces of this type are client
interfaces.
|
boolean | isFcCollectionItf() - Indicates how many interfaces of this type a component may have.
|
boolean | isFcOptionalItf() - Returns true if component interfaces of this type are optional.
|
getFcItfName
public String getFcItfName()
Returns the name of component interfaces of this type. More precisely,
because some interfaces can be created dynamically (see
isFcCollectionItf
), this name is in fact a
prefix of the real names of interfaces of this type.
- the name of component interfaces of this type inside their
components (see
getFcItfName
).
getFcItfSignature
public String getFcItfSignature()
Returns the signatures of the methods of interfaces of this type. In Java
this method returns the fully qualified name of a Java interface
corresponding to these method signatures.
- the signatures of the methods of interfaces of this type.
isFcClientItf
public boolean isFcClientItf()
Returns true if component interfaces of this type are client
interfaces.
- true if component interfaces of this type are client
interfaces, i.e., interfaces that are required, or false if
they are server interfaces, i.e., interfaces that are provided.
isFcCollectionItf
public boolean isFcCollectionItf()
Indicates how many interfaces of this type a component may have. A
singleton interface type means that a component must have exactly one
interface of this type. A collection interface type means that a component
may have an arbitrary number of interfaces of this type (whose names must
all begin with the name specified in this interface type).
- false if this type is a singleton interface type.
isFcOptionalItf
public boolean isFcOptionalItf()
Returns true if component interfaces of this type are optional. A
mandatory interface is guaranteed to be "available" when the component
is started. For a client interface, this means that the interface is bound,
and that it is bound to a mandatory interface. An optional interface may
not be available when the component is started (for a client interface, it
means that the interface may not be bound).
- true if component interfaces of this type are optional.