org.objectweb.fractal.api
Interface Interface

public interface Interface

An interface to introspect component interfaces. If a Fractal component supports interface introspection, then the interfaces returned by the getFcInterfaces and getFcInterfaces methods can be cast into this Java interface, in order to get their name or their type.

Method Summary

String	getFcItfName() Returns the name of this interface inside its component.
Component	getFcItfOwner() Returns the component to which this interface belongs.
Type	getFcItfType() Returns the type of this interface.
boolean	isFcInternalItf() Returns true if this interface is an internal interface.

Method Detail

getFcItfOwner

public Component getFcItfOwner()

Returns the component to which this interface belongs.

Returns:

the Component interface of the component to which this interface belongs.

getFcItfName

public String getFcItfName()

Returns the name of this interface inside its component. This name is "unique" inside the component: more precisely, all the external interfaces of the component have distinct names, as well as all its internal interfaces. However an internal interface can have the same name as an external interface. Of course, two interfaces in two distinct components can also have the same name.

Returns:

the name of this interface inside its component.

getFcItfType

public Type getFcItfType()

Returns the type of this interface. The type system is not specified here, in order to allow many type systems to be used. The basic type system specified in the org.objectweb.fractal.api.type package should be sufficient in most cases, but another one can be used if necessary.

Returns:

the type of this interface.

isFcInternalItf

public boolean isFcInternalItf()

Returns true if this interface is an internal interface.

Returns:

true if this interface is an internal interface.