Constructor Detail

• Module

  public Module()

  The default constructor for the model.

Method Detail

• getName

  public String getName()

  This method returns the fully qualified name.

  Returns:

  The fully qualified name

• setName

  public void setName(String fqn)

  This method sets the fully qualified name.

  Parameters:

  fqn - The fully qualified name

• getLocalName

  public String getLocalName()

  This method returns the last component of the fully qualified name.

  Returns:

  The local name

• getLocatedRole

  public Role getLocatedRole()

  This method returns the role associated with a local module. If the module is a global module, then null is returned.

  Returns:

  The located role, if the module is local

• getImports

  public List<ImportDecl> getImports()

  This method returns the list of import definitions.

  Returns:

  The import definitions

• getPayloadTypeDeclarations

  public List<PayloadTypeDecl> getPayloadTypeDeclarations()

  This method returns the list of payload types.

  Returns:

  The payload types

• getTypeDeclaration

  public PayloadTypeDecl getTypeDeclaration(String name)

  This method returns the payload type associated with the supplied name.

  Parameters:

  name - The name

  Returns:

  The payload type, or null if not found

• getProtocols

  public List<ProtocolDecl> getProtocols()

  This method returns the list of protocols.

  Returns:

  The protocols

• getProtocol

  public ProtocolDecl getProtocol(String name)

  This method returns the protocol associated with the supplied name.

  Parameters:

  name - The name

  Returns:

  The protocol, or null if not found

• visit

  public void visit(Visitor visitor)

  This method visits the model object using the supplied visitor.

  Specified by:

  visit in class ModelObject

  Parameters:

  visitor - The visitor

• toString

  public String toString()

  Overrides:

  toString in class Object

• toText

  public void toText(StringBuffer buf,
            int level)

  This method generates a text representation of the protocol component.

  Specified by:

  toText in class ModelObject

  Parameters:

  buf - The text buffer

  level - The indentation level, if relevant