Prism.core
Interface IBrick

All Known Subinterfaces:
IArchitecture, IComponent, IConnector, IPort
All Known Implementing Classes:
Architecture, Brick, Component, Connector, ExtensibleArchitecture, ExtensibleComponent, ExtensibleConnector, ExtensiblePort, HelloWorldClient, HelloWorldServer, Port

public interface IBrick

This interface is implemented by any object that wants to represent a brick in Prism.

Version:
2.0
Author:
USC Soft. Arch. Group. Contact: Sam Malek malek@usc.edu

Method Summary
 void add(Event event)
          Add a message to the scaffold which results in a message getting added to the scaffold's queue.
 java.lang.String getName()
           
 AbstractScaffold getScaffold()
           
 int getStyle()
           
 void handle(Event e)
          This abstract method needs to be overriden by any object that extends Brick.
 void setName(java.lang.String name)
           
 void setScaffold(AbstractScaffold scaffold)
           
 void start()
          By default a brick does not do anything.
 

Method Detail

start

void start()
By default a brick does not do anything. The start method is called to activate this brick


add

void add(Event event)
Add a message to the scaffold which results in a message getting added to the scaffold's queue.

Parameters:
event - Event object to be added

handle

void handle(Event e)
This abstract method needs to be overriden by any object that extends Brick. The subclassing object shall provide the desired implementation to handle an Event.

Parameters:
eEvent - object to be handled

setScaffold

void setScaffold(AbstractScaffold scaffold)

getScaffold

AbstractScaffold getScaffold()

setName

void setName(java.lang.String name)

getName

java.lang.String getName()

getStyle

int getStyle()