A B C D E G H I L M O P R S T U V

A

AbstractModelObjectVisitor - Class in org.scribble.protocol.model

This class provides a default visitor which can be used to traverse a model.

AbstractModelObjectVisitor() - Constructor for class org.scribble.protocol.model.AbstractModelObjectVisitor

The default constructor.

accept(TypeImportList) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method visits an import component.

accept(ProtocolImportList) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method visits an import component.

accept(Introduces) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method visits the role list.

accept(Interaction) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method visits an interaction component.

accept(Recursion) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method visits a recursion component.

accept(Run) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a run.

accept(Inline) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method accepts an 'inline' construct.

accept(TypeImport) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method accepts a type import.

accept(ProtocolImport) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method accepts a protocol import.

accept(End) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method visits an end statement.

accept(TypeImportList) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits an import component.

accept(ProtocolImportList) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits an import component.

accept(Interaction) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits an interaction component.

accept(Run) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a run construct.

accept(Inline) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits an use component.

accept(Recursion) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits a recursion component.

accept(Introduces) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits the role list.

accept(TypeImport) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits a type component.

accept(ProtocolImport) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits a protocol import component.

accept(End) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method visits an end statement.

accept(TypeImportList) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits an import component.

accept(ProtocolImportList) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits an import component.

accept(Interaction) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits an interaction component.

accept(Inline) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits a use component.

accept(Recursion) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits a recursion component.

accept(Introduces) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits the role list.

accept(Run) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a run construct.

accept(TypeImport) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits a type component.

accept(ProtocolImport) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits a protocol import component.

accept(End) - Method in class org.scribble.protocol.model.DefaultVisitor

This method visits an end statement.

accept(Run) - Method in interface org.scribble.protocol.model.Visitor

This method visits a run construct.

accept(TypeImportList) - Method in interface org.scribble.protocol.model.Visitor

This method visits an import component.

accept(ProtocolImportList) - Method in interface org.scribble.protocol.model.Visitor

This method visits an import component.

accept(Interaction) - Method in interface org.scribble.protocol.model.Visitor

This method visits an interaction component.

accept(Introduces) - Method in interface org.scribble.protocol.model.Visitor

This method visits the role list.

accept(Recursion) - Method in interface org.scribble.protocol.model.Visitor

This method visits a recursion component.

accept(Inline) - Method in interface org.scribble.protocol.model.Visitor

This method visits an inline component.

accept(TypeImport) - Method in interface org.scribble.protocol.model.Visitor

This method visits a type import component.

accept(ProtocolImport) - Method in interface org.scribble.protocol.model.Visitor

This method visits a protocol import component.

accept(End) - Method in interface org.scribble.protocol.model.Visitor

This method visits an end statement.

accept(Interaction) - Method in class org.scribble.protocol.util.InteractionUtil.InitialInteractionVisitor

accept(Run) - Method in class org.scribble.protocol.util.InteractionUtil.InitialInteractionVisitor

accept(Run) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

accept(Interaction) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

accept(Introduces) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

accept(Inline) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

accept(Recursion) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

accept(End) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

This method visits an end statement.

Activity - Class in org.scribble.protocol.model

This class represents the base class for all Scribble definition components.

Activity() - Constructor for class org.scribble.protocol.model.Activity

The default constructor.

Activity(Activity) - Constructor for class org.scribble.protocol.model.Activity

The copy constructor.

ActivityUtil - Class in org.scribble.protocol.util

This class provides utility functions associated with activities.

add(Activity) - Method in class org.scribble.protocol.model.Block

This method adds an activity to the block.

add(E) - Method in class org.scribble.protocol.model.ContainmentList

Appends the specified element to the end of this list (optional operation).

add(int, E) - Method in class org.scribble.protocol.model.ContainmentList

Inserts the specified element at the specified position in this list (optional operation).

addAll(Collection<? extends E>) - Method in class org.scribble.protocol.model.ContainmentList

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).

addAll(int, Collection<? extends E>) - Method in class org.scribble.protocol.model.ContainmentList

Inserts all of the elements in the specified collection into this list at the specified position (optional operation).

added(ModelObject, ModelObject, int) - Method in interface org.scribble.protocol.conformance.ConformanceHandler

This method indicates that a new model object has been detected in the model.

added(ModelObject, ModelObject, int) - Method in class org.scribble.protocol.conformance.LoggingConformanceHandler

This method indicates that a new model object has been detected in the model.

AnnotationProcessor - Interface in org.scribble.protocol.parser

This interface represents an annotation processor, used to process free format text annotations.

B

Block - Class in org.scribble.protocol.model

This class represents a group of activities.

Block() - Constructor for class org.scribble.protocol.model.Block

C

checkActivity(Activity) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

This method checks the supplied activity to determine if it is the activity being searched for, and if so identifies the roles in scope as the result.

Choice - Class in org.scribble.protocol.model

This class represents the Choice construct between two or more paths.

Choice() - Constructor for class org.scribble.protocol.model.Choice

This is the default constructor.

ChoiceUtil - Class in org.scribble.protocol.util

Utility functions for the choice construct.

clear() - Method in class org.scribble.protocol.model.ContainmentList

Removes all of the elements from this list (optional operation).

CONFORMANCE_MODEL_OBJECT - Static variable in class org.scribble.protocol.conformance.LoggingConformanceHandler

Conformance model object.

CONFORMANCE_REFERENCE_INDEX - Static variable in class org.scribble.protocol.conformance.LoggingConformanceHandler

Conformance model object.

CONFORMANCE_REFERENCE_OBJECT - Static variable in class org.scribble.protocol.conformance.LoggingConformanceHandler

Conformance model object.

CONFORMANCE_REFERENCE_PARENT - Static variable in class org.scribble.protocol.conformance.LoggingConformanceHandler

Conformance model object.

ConformanceHandler - Interface in org.scribble.protocol.conformance

This interface can be used to be informed of the conformance results associated with performing a conformance check on two local protocol models.

conforms(ProtocolModel, ProtocolModel, ConformanceHandler) - Method in interface org.scribble.protocol.conformance.ProtocolConformer

This method checks whether the supplied model conforms to the reference model.

ContainmentList<E extends ModelObject> - Class in org.scribble.protocol.model

This class represents a list that understands how to manage containment and parent relationships.

ContainmentList(ModelObject, Class<E>) - Constructor for class org.scribble.protocol.model.ContainmentList

This is the constructor for the containment list.

createVisitor(Journal, OutputStream) - Method in class org.scribble.protocol.export.text.TextProtocolExporter

This method creates the text protocol export visitor.

D

DataType - Class in org.scribble.protocol.model

This class represents the data type bound to a particular type name used in the protocol.

DataType() - Constructor for class org.scribble.protocol.model.DataType

Default constructor.

DataType(DataType) - Constructor for class org.scribble.protocol.model.DataType

Copy constructor.

DataType(String) - Constructor for class org.scribble.protocol.model.DataType

Constructor used to initialise the data type details.

DefaultProtocolContext - Class in org.scribble.protocol

This interface represents the context in which a protocol will be processed.

DefaultProtocolContext() - Constructor for class org.scribble.protocol.DefaultProtocolContext

This is the default constructor.

DefaultProtocolContext(ProtocolParserManager, ResourceLocator) - Constructor for class org.scribble.protocol.DefaultProtocolContext

This is the constructor for the default protocol context implementation.

DefaultProtocolExportManager - Class in org.scribble.protocol.export

This is the default protocol export manager implementation.

DefaultProtocolExportManager() - Constructor for class org.scribble.protocol.export.DefaultProtocolExportManager

DefaultProtocolParserManager - Class in org.scribble.protocol.parser

This class represents the default implementation of the ProtocolProtocolManager interface.

DefaultProtocolParserManager() - Constructor for class org.scribble.protocol.parser.DefaultProtocolParserManager

This is the default constructor.

DefaultVisitor - Class in org.scribble.protocol.model

This class provides a default visitor which can be used to traverse a model.

DefaultVisitor() - Constructor for class org.scribble.protocol.model.DefaultVisitor

This is the default constructor.

DefaultVisitor(boolean) - Constructor for class org.scribble.protocol.model.DefaultVisitor

This constructor configures the default group return value.

derivedFrom(ModelObject) - Method in class org.scribble.protocol.model.ModelObject

This method establishes the necessary information to indicate that the current model object is derived from the supplied source model object.

DirectedChoice - Class in org.scribble.protocol.model

This class represents the Choice construct between two or more paths.

DirectedChoice() - Constructor for class org.scribble.protocol.model.DirectedChoice

This is the default constructor.

Do - Class in org.scribble.protocol.model

This class represents the Try/Escape construct.

Do() - Constructor for class org.scribble.protocol.model.Do

This is the default constructor.

E

end(Block) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a block.

end(Choice) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a choice.

end(DirectedChoice) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a choice.

end(OnMessage) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a on-message.

end(Parallel) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a parallel.

end(Do) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a try/escape.

end(Repeat) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a repeat.

end(Unordered) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a unordered block.

end(RecBlock) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of a labelled block.

end(Protocol) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of the protocol.

end(Interrupt) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the end of the interrupt.

end(Block) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a block.

end(Protocol) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a protocol.

end(Choice) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a choice.

end(DirectedChoice) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a directed choice.

end(OnMessage) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a on-message.

end(Parallel) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a parallel.

end(Repeat) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a repeat.

end(RecBlock) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a labelled block.

end(Unordered) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of an Unordered construct.

end(Do) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a try escape.

end(Interrupt) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the end of a catch block.

end(Block) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a block.

end(Protocol) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a protocol.

end(Choice) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a choice.

end(DirectedChoice) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a directed choice.

end(OnMessage) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a on-message.

end(Parallel) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a parallel.

end(Repeat) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a repeat.

end(RecBlock) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a labelled block.

end(Unordered) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of an Unordered construct.

end(Do) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a try escape.

end(Interrupt) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the end of a catch block.

End - Class in org.scribble.protocol.model

This class represents the Include construct.

End() - Constructor for class org.scribble.protocol.model.End

This is the default constructor.

End(End) - Constructor for class org.scribble.protocol.model.End

This is the copy constructor.

end(Block) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a block.

end(Choice) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a choice.

end(DirectedChoice) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a directed choice.

end(OnMessage) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a on-message.

end(Parallel) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a parallel.

end(Protocol) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a protocol.

end(Repeat) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a repeat.

end(RecBlock) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a labelled block.

end(Unordered) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a unordered block.

end(Do) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a try escape.

end(Interrupt) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the end of a catch block.

end(Choice) - Method in class org.scribble.protocol.util.InteractionUtil.InitialInteractionVisitor

end(Block) - Method in class org.scribble.protocol.util.InteractionUtil.InitialInteractionVisitor

end(Block) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

END_LOCATION - Static variable in interface org.scribble.protocol.model.ModelProperties

This construct defines the end location in a textual description of a scribble construct.

endBlock(Block) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

Process the end of the block.

endOfBlock(Block) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

equals(Object) - Method in class org.scribble.protocol.model.Block

equals(Object) - Method in class org.scribble.protocol.model.Choice

equals(Object) - Method in class org.scribble.protocol.model.DirectedChoice

equals(Object) - Method in class org.scribble.protocol.model.Interaction

equals(Object) - Method in class org.scribble.protocol.model.MessageSignature

equals(Object) - Method in class org.scribble.protocol.model.ParameterDefinition

equals(Object) - Method in class org.scribble.protocol.model.RecBlock

equals(Object) - Method in class org.scribble.protocol.model.Recursion

equals(Object) - Method in class org.scribble.protocol.model.Role

equals(Object) - Method in class org.scribble.protocol.model.TypeReference

export(ProtocolModel, Journal, OutputStream) - Method in interface org.scribble.protocol.export.ProtocolExporter

This method exports the supplied protocol model, in the implementation specific format, to the specified output stream.

export(ProtocolModel, Journal, OutputStream) - Method in class org.scribble.protocol.export.text.TextProtocolExporter

This method exports the supplied protocol model, in the implementation specific format, to the specified output stream.

G

get(int) - Method in class org.scribble.protocol.model.Block

This method returns the activity at the specified index.

getAnnotation(String, Map<String, Object>, Journal) - Method in interface org.scribble.protocol.parser.AnnotationProcessor

This method is called when an annotation is found.

getAnnotations() - Method in class org.scribble.protocol.model.ModelObject

This method returns the list of annotations associated with the model object.

getBlock() - Method in class org.scribble.protocol.model.Do

This method returns the block of activities associated with the definition.

getBlock() - Method in class org.scribble.protocol.model.Interrupt

This method returns the block of activities associated with the definition.

getBlock() - Method in class org.scribble.protocol.model.OnMessage

This method returns the activities.

getBlock() - Method in class org.scribble.protocol.model.Protocol

This method returns the block of activities associated with the definition.

getBlock() - Method in class org.scribble.protocol.model.RecBlock

This method returns the activities.

getBlock() - Method in class org.scribble.protocol.model.Repeat

This method returns the activities.

getBlock() - Method in class org.scribble.protocol.model.Unordered

This method returns the activities.

getBlockPath(Block) - Static method in class org.scribble.protocol.util.RoleUtil

This method returns the list of blocks from the root to the supplied block.

getContents() - Method in class org.scribble.protocol.model.Block

This method returns the contents associated with the block.

getDataType() - Method in class org.scribble.protocol.model.TypeImport

This method returns the data type.

getDeclaredRoles(Block) - Static method in class org.scribble.protocol.util.RoleUtil

This method returns the roles defined within the parent scope of the supplied activity.

getDetails() - Method in class org.scribble.protocol.model.DataType

This method returns the details.

getEnclosingBlock(Protocol, Role, boolean) - Static method in class org.scribble.protocol.util.RoleUtil

This method returns the innermost block that encloses all of the activities associated with the supplied role.

getEnclosingProtocol() - Method in class org.scribble.protocol.model.Activity

This method returns the protocol in which this activity is contained.

getEnclosingProtocol() - Method in class org.scribble.protocol.model.Protocol

This method returns the protocol in which this activity is contained.

getEnclosingProtocol(Role) - Static method in class org.scribble.protocol.util.RoleUtil

This method returns the enclosing protocol associated with the supplied role.

getException() - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method return the exception.

getExporter(String) - Method in class org.scribble.protocol.export.DefaultProtocolExportManager

This method returns the protocol exporter associated with the supplied id.

getExporter(String) - Method in interface org.scribble.protocol.export.ProtocolExportManager

This method returns the protocol exporter associated with the supplied id.

getExporters() - Method in class org.scribble.protocol.export.DefaultProtocolExportManager

This method returns the list of exporters registered with the manager.

getExporters() - Method in interface org.scribble.protocol.export.ProtocolExportManager

This method returns the list of exporters registered with the manager.

getExportManager() - Static method in class org.scribble.protocol.export.ProtocolExportManagerFactory

This method returns the export manager.

getFormat() - Method in class org.scribble.protocol.model.TypeImportList

This method returns the format.

getFromRole() - Method in class org.scribble.protocol.model.DirectedChoice

This method returns the from role.

getFromRole() - Method in class org.scribble.protocol.model.Interaction

This method returns the optional 'from' role.

getFromRole() - Method in class org.scribble.protocol.model.Run

This method returns the optional 'from' role.

getFromRole(ModelObject) - Static method in class org.scribble.protocol.util.InteractionUtil

This method gets the 'from' role associated with the activity.

getId() - Method in interface org.scribble.protocol.export.ProtocolExporter

This method returns the id of the exporter.

getId() - Method in class org.scribble.protocol.export.text.TextProtocolExporter

This method returns the id of the exporter.

getImports() - Method in class org.scribble.protocol.model.ProtocolModel

This method returns the list of import definitions.

getInitialInteractions(ModelObject) - Static method in class org.scribble.protocol.util.InteractionUtil

This method determines the initial interactions associated with the supplied model object.

getInnerProtocol(Protocol, ProtocolReference) - Static method in class org.scribble.protocol.util.RunUtil

This method attempts to locate an inner protocol associated with the supplied protocol reference.

getInterrupts() - Method in class org.scribble.protocol.model.Do

This method returns the list of interrupt statements associated with the global escape (do).

getIntroducedRole(String) - Method in class org.scribble.protocol.model.Introduces

This method returns the role associated with the supplied name.

getIntroducedRoles() - Method in class org.scribble.protocol.model.Introduces

This method returns the list of roles.

getIntroducer() - Method in class org.scribble.protocol.model.Introduces

This method returns the introducing role.

getJournal() - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method returns the journal.

getLabel() - Method in class org.scribble.protocol.model.RecBlock

This method returns the label associated with the labelled block construct.

getLabel() - Method in class org.scribble.protocol.model.Recursion

This method returns the label associated with the recursion construct.

getLabel(MessageSignature) - Static method in class org.scribble.protocol.util.ChoiceUtil

This method returns the label associated with the message signature.

getLocatedRole() - Method in class org.scribble.protocol.model.Protocol

This method returns the located role.

getLocation() - Method in class org.scribble.protocol.model.ProtocolImport

This method returns the location of the schema.

getLocation() - Method in class org.scribble.protocol.model.TypeImportList

This method returns the location of the schema.

getMessageSignature() - Method in class org.scribble.protocol.model.Interaction

This method returns the message signature.

getMessageSignature() - Method in class org.scribble.protocol.model.OnMessage

This method returns the message signature.

getMessageSignature(ModelObject) - Static method in class org.scribble.protocol.util.InteractionUtil

This method gets the message signature associated with the activity.

getModel() - Method in class org.scribble.protocol.model.ModelObject

This method returns the protocol model in which this object is contained.

getModel() - Method in class org.scribble.protocol.model.Protocol

This method returns the model in which this definition is contained.

getName() - Method in interface org.scribble.protocol.export.ProtocolExporter

This method returns the name of the exporter for use in user based selectors.

getName() - Method in class org.scribble.protocol.export.text.TextProtocolExporter

This method returns the name of the exporter for use in user based selectors.

getName() - Method in class org.scribble.protocol.model.Parameter

This method returns the local name.

getName() - Method in class org.scribble.protocol.model.ParameterDefinition

This method returns the name of the parameter.

getName() - Method in class org.scribble.protocol.model.Protocol

This method returns the name.

getName() - Method in class org.scribble.protocol.model.ProtocolImport

This method returns the name of the type being imported.

getName() - Method in class org.scribble.protocol.model.ProtocolReference

This method returns the name associated with the model reference.

getName() - Method in class org.scribble.protocol.model.Role

This method returns the name of the role.

getName() - Method in class org.scribble.protocol.model.TypeImport

This method returns the name of the type being imported.

getName() - Method in class org.scribble.protocol.model.TypeReference

This method returns the name associated with the model reference.

getNestedProtocol(String) - Method in class org.scribble.protocol.model.Protocol

This method returns the nested-protocol associated with the supplied name.

getNestedProtocols() - Method in class org.scribble.protocol.model.Protocol

This method returns the list of nested protocols.

getOnMessages() - Method in class org.scribble.protocol.model.DirectedChoice

This method returns the list of on-message blocks representing the different paths of the directed choice.

getOperation() - Method in class org.scribble.protocol.model.MessageSignature

This method returns the optional operation.

getParameter(String) - Method in class org.scribble.protocol.model.Inline

This method returns the declaration binding associated with the supplied declaration.

getParameter(String) - Method in class org.scribble.protocol.model.Run

This method returns the parameter associated with the supplied declaration.

getParameterDefinition(String) - Method in class org.scribble.protocol.model.Protocol

This method returns the parameter definition associated with the supplied name.

getParameterDefinitions() - Method in class org.scribble.protocol.model.Protocol

This method returns the parameters associated with the protocol.

getParameters() - Method in class org.scribble.protocol.model.Inline

This method returns the bindings for the composition construct.

getParameters() - Method in class org.scribble.protocol.model.Run

This method returns the parameters for the composition construct.

getParent() - Method in class org.scribble.protocol.model.ModelObject

This method returns the parent of this model object.

getParserManager() - Static method in class org.scribble.protocol.parser.ProtocolParserManagerFactory

This method returns the parser manager.

getParsers() - Method in class org.scribble.protocol.parser.DefaultProtocolParserManager

This method returns the list of protocol parsers.

getParsers() - Method in interface org.scribble.protocol.parser.ProtocolParserManager

This method returns the list of protocol parsers.

getPaths() - Method in class org.scribble.protocol.model.Choice

This method returns the list of mutually exclusive activity blocks that comprise the multi-path construct.

getPaths() - Method in class org.scribble.protocol.model.Parallel

This method returns the list of concurrent activity blocks that comprise the multi-path construct.

getProperties() - Method in class org.scribble.protocol.model.ModelObject

This method returns the properties associated with this model object.

getProtocol() - Method in class org.scribble.protocol.model.ProtocolModel

This method returns the definition associated with this model.

getProtocolImport(String) - Method in class org.scribble.protocol.model.ProtocolImportList

This method returns the imported protocol associated with the supplied name.

getProtocolImport(ProtocolModel, ProtocolReference) - Static method in class org.scribble.protocol.util.ProtocolModelUtil

This method attempts to locate a protocol import statement associated with the supplied protocol reference.

getProtocolImports() - Method in class org.scribble.protocol.model.ProtocolImportList

This method returns the list of imported protocols.

getProtocolModel(ProtocolImport, Journal) - Method in class org.scribble.protocol.DefaultProtocolContext

This method retrieves a protocol model associated with a protocol import statement.

getProtocolModel(ProtocolImport, Journal) - Method in interface org.scribble.protocol.ProtocolContext

This method retrieves a protocol model associated with a protocol import statement.

getProtocolReference() - Method in class org.scribble.protocol.model.Inline

This method returns the protocol reference associated with the run construct.

getProtocolReference() - Method in class org.scribble.protocol.model.Run

This method returns the protocol reference associated with the run construct.

getProtocolValidationManager() - Method in interface org.scribble.protocol.projection.ProtocolProjector

This method returns the protocol validation manager.

getResourceLocator() - Method in class org.scribble.protocol.DefaultProtocolContext

This method returns the resource locator.

getResourceLocator() - Method in interface org.scribble.protocol.ProtocolContext

This method returns the resource locator.

getRole() - Method in class org.scribble.protocol.model.Choice

This method returns the role.

getRole() - Method in class org.scribble.protocol.model.ParameterDefinition

This method returns the role associated with the parameter, if the parameter represents a role, otherwise null.

getRole() - Method in class org.scribble.protocol.model.ProtocolReference

This method returns the located role.

getRoles() - Method in class org.scribble.protocol.model.Protocol

This method returns the list of roles defined within the protocol definition.

getRoles() - Method in class org.scribble.protocol.model.ProtocolModel

This method returns the distinct list of roles defined in the protocol and its nested-protocols.

getRoles() - Method in class org.scribble.protocol.model.Repeat

This method returns the list of roles at which the repeat decision is located.

getRolesInScope(Activity) - Static method in class org.scribble.protocol.util.RoleUtil

This method determines the set of roles that are in the scope for the supplied activity.

getTopLevelProtocol() - Method in class org.scribble.protocol.model.Protocol

This method returns the top level protocol.

getToRole(ModelObject) - Static method in class org.scribble.protocol.util.InteractionUtil

This method gets the 'to' role associated with the activity.

getToRoles() - Method in class org.scribble.protocol.model.DirectedChoice

This method returns the optional (one or many) 'to' roles.

getToRoles() - Method in class org.scribble.protocol.model.Interaction

This method returns the optional (one or many) 'to' roles.

getType() - Method in class org.scribble.protocol.model.ContainmentList

This method returns the base type associated with the list elements.

getType() - Method in class org.scribble.protocol.model.ParameterDefinition

This method returns the type of the parameter.

getTypeImport(String) - Method in class org.scribble.protocol.model.TypeImportList

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

getTypeImport(TypeReference) - Static method in class org.scribble.protocol.util.TypesUtil

This method identifies the type import for the supplied type reference.

getTypeImports() - Method in class org.scribble.protocol.model.TypeImportList

This method returns the list of imported types.

getTypeReferences() - Method in class org.scribble.protocol.model.MessageSignature

This method returns the list of type references.

getUsedRoles(ModelObject) - Static method in class org.scribble.protocol.util.RoleUtil

This method returns the set of roles that are associated with the supplied activity.

H

hashCode() - Method in class org.scribble.protocol.model.Block

hashCode() - Method in class org.scribble.protocol.model.Choice

hashCode() - Method in class org.scribble.protocol.model.DirectedChoice

hashCode() - Method in class org.scribble.protocol.model.Interaction

hashCode() - Method in class org.scribble.protocol.model.MessageSignature

hashCode() - Method in class org.scribble.protocol.model.ParameterDefinition

hashCode() - Method in class org.scribble.protocol.model.RecBlock

hashCode() - Method in class org.scribble.protocol.model.Recursion

hashCode() - Method in class org.scribble.protocol.model.Role

hashCode() - Method in class org.scribble.protocol.model.TypeReference

This method returns the hash code.

I

ImportList - Class in org.scribble.protocol.model

This class represents an import definition associated with a model.

ImportList() - Constructor for class org.scribble.protocol.model.ImportList

The default constructor.

ImportList(ImportList) - Constructor for class org.scribble.protocol.model.ImportList

The copy constructor.

indent() - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indents the output.

indexOf(Activity) - Method in class org.scribble.protocol.model.Block

This method returns the index of the supplied activity.

Inline - Class in org.scribble.protocol.model

This class represents the Include construct.

Inline() - Constructor for class org.scribble.protocol.model.Inline

This is the default constructor.

Inline(Inline) - Constructor for class org.scribble.protocol.model.Inline

This is the copy constructor.

Interaction - Class in org.scribble.protocol.model

This class represents an interaction: the communication of a message from one role to another, or several others.

Interaction() - Constructor for class org.scribble.protocol.model.Interaction

The default constructor.

Interaction(Interaction) - Constructor for class org.scribble.protocol.model.Interaction

The copy constructor.

Interaction(Role, MessageSignature) - Constructor for class org.scribble.protocol.model.Interaction

This constructor initializes the 'from' role and message signature.

Interaction(Role, Role, MessageSignature) - Constructor for class org.scribble.protocol.model.Interaction

This method initializes the 'from' and 'to' roles, and message signature.

Interaction(Role, Collection<Role>, MessageSignature) - Constructor for class org.scribble.protocol.model.Interaction

This method initializes the 'from' and 'to' roles, and message signature.

InteractionUtil - Class in org.scribble.protocol.util

This class provides utility functions for the interaction construct.

InteractionUtil.InitialInteractionVisitor - Class in org.scribble.protocol.util

This class identifies the initial interaction.

InteractionUtil.InitialInteractionVisitor(List<ModelObject>) - Constructor for class org.scribble.protocol.util.InteractionUtil.InitialInteractionVisitor

This is the constructor.

Interrupt - Class in org.scribble.protocol.model

This class represents a group of activities within an interrupt block associated with a global escape.

Interrupt() - Constructor for class org.scribble.protocol.model.Interrupt

Introduces - Class in org.scribble.protocol.model

This class represents the list of roles introduced by an existing role within a Scribble definition.

Introduces() - Constructor for class org.scribble.protocol.model.Introduces

The default constructor.

Introduces(Introduces) - Constructor for class org.scribble.protocol.model.Introduces

The copy constructor.

isBehaviour(Activity) - Static method in class org.scribble.protocol.util.ActivityUtil

This method determines whether the activity is a behavioural element.

isConcreteTypesDefined(ProtocolModel) - Static method in class org.scribble.protocol.util.TypesUtil

This method determines whether the protocol model has concrete types defined.

isDeclaration(Activity) - Static method in class org.scribble.protocol.util.ActivityUtil

This method determines whether the activity is a declaration.

isEndOfBlock(Block) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method determines if this is the last block.

isInitialInteraction(ModelObject, ModelObject) - Static method in class org.scribble.protocol.util.InteractionUtil

This method determines whether the supplied interaction is the first within the supplied scope.

isLocated() - Method in class org.scribble.protocol.model.ProtocolModel

This method determines whether the model is located.

isRole() - Method in class org.scribble.protocol.model.ParameterDefinition

This method determines whether the parameter represents a role.

isSupported(Content) - Method in interface org.scribble.protocol.parser.ProtocolParser

This method determines whether the parser supports the specified content.

L

LoggingConformanceHandler - Class in org.scribble.protocol.conformance

This implementation records conformance related information to the logging journal.

LoggingConformanceHandler(Journal) - Constructor for class org.scribble.protocol.conformance.LoggingConformanceHandler

This constructor initialises the conformance handler with the journal.

M

MessageSignature - Class in org.scribble.protocol.model

This class represents a message signature.

MessageSignature() - Constructor for class org.scribble.protocol.model.MessageSignature

The default constructor.

MessageSignature(TypeReference) - Constructor for class org.scribble.protocol.model.MessageSignature

No-operation constructor: only one TypeReference is allowed.

MessageSignature(String, Collection<TypeReference>) - Constructor for class org.scribble.protocol.model.MessageSignature

Constructor for MessageSignatures that comprise an operation.

MessageSignature(MessageSignature) - Constructor for class org.scribble.protocol.model.MessageSignature

The copy constructor.

ModelObject - Class in org.scribble.protocol.model

This is the generic object from which all Scribble model objects are derived.

ModelObject() - Constructor for class org.scribble.protocol.model.ModelObject

This is the default constructor for the model object.

ModelObject(ModelObject) - Constructor for class org.scribble.protocol.model.ModelObject

This is the copy constructor.

ModelProperties - Interface in org.scribble.protocol.model

This interface provides the definitions for the properties associated with objects in the model.

O

OnMessage - Class in org.scribble.protocol.model

This class represents a possible path of a directed choice, triggered by a specified message signature.

OnMessage() - Constructor for class org.scribble.protocol.model.OnMessage

This is the default constructor.

org.scribble.protocol - package org.scribble.protocol

org.scribble.protocol.conformance - package org.scribble.protocol.conformance

org.scribble.protocol.export - package org.scribble.protocol.export

org.scribble.protocol.export.text - package org.scribble.protocol.export.text

org.scribble.protocol.model - package org.scribble.protocol.model

org.scribble.protocol.parser - package org.scribble.protocol.parser

org.scribble.protocol.projection - package org.scribble.protocol.projection

org.scribble.protocol.util - package org.scribble.protocol.util

output(String) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method outputs the supplied string.

outputInteraction(Interaction) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method outputs the information about the supplied interaction.

P

Parallel - Class in org.scribble.protocol.model

This class represents the Parallel construct with two or more concurrent paths.

Parallel() - Constructor for class org.scribble.protocol.model.Parallel

This is the default constructor.

Parameter - Class in org.scribble.protocol.model

This class represents the binding between a declaration and the name of a declaration in a composed definition.

Parameter() - Constructor for class org.scribble.protocol.model.Parameter

The default constructor.

Parameter(String) - Constructor for class org.scribble.protocol.model.Parameter

This constructor initializes the declaration (local name) and bound name.

Parameter(Parameter) - Constructor for class org.scribble.protocol.model.Parameter

This is the copy constructor.

ParameterDefinition - Class in org.scribble.protocol.model

This class represents a parameter.

ParameterDefinition() - Constructor for class org.scribble.protocol.model.ParameterDefinition

This is the default constructor.

ParameterDefinition(String) - Constructor for class org.scribble.protocol.model.ParameterDefinition

This constructor initializes the parameter as representing a role with the supplied name.

parse(ProtocolContext, Content, Journal) - Method in class org.scribble.protocol.parser.DefaultProtocolParserManager

This method parses the supplied content to create a protocol model.

parse(ProtocolContext, Content, Journal) - Method in interface org.scribble.protocol.parser.ProtocolParser

This method parses the supplied input stream to create a protocol model.

parse(ProtocolContext, Content, Journal) - Method in interface org.scribble.protocol.parser.ProtocolParserManager

This method parses the supplied content to create a protocol model.

process(ModelObject) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method can be implemented to process all of the model objects within a particular protocol model.

project(ProtocolContext, ProtocolModel, Role, Journal) - Method in interface org.scribble.protocol.projection.ProtocolProjector

This method projects a 'global' protocol model to a specified role's 'local' protocol model.

Protocol - Class in org.scribble.protocol.model

This class represents the protocol notation.

Protocol() - Constructor for class org.scribble.protocol.model.Protocol

The default constructor.

PROTOCOL_TYPE - Static variable in class org.scribble.protocol.ProtocolDefinitions

The protocol type.

ProtocolConformer - Interface in org.scribble.protocol.conformance

This interface represents a conformance checking capability for the Protocol description.

ProtocolContext - Interface in org.scribble.protocol

This interface provides access to capabilities based on the protocol being processed.

ProtocolDefinitions - Class in org.scribble.protocol

This class provides common protocol definitions.

ProtocolExporter - Interface in org.scribble.protocol.export

This interface provides an export mechanism for converting a Protocol Model into a range of other representations.

ProtocolExportManager - Interface in org.scribble.protocol.export

This interface manages a set of protocol exporters.

ProtocolExportManagerFactory - Class in org.scribble.protocol.export

This method returns an instance of the export manager.

ProtocolImport - Class in org.scribble.protocol.model

This class represents an imported protocol.

ProtocolImport() - Constructor for class org.scribble.protocol.model.ProtocolImport

The default constructor.

ProtocolImport(ProtocolImport) - Constructor for class org.scribble.protocol.model.ProtocolImport

The copy constructor.

ProtocolImportList - Class in org.scribble.protocol.model

This class represents an import definition associated with a model.

ProtocolImportList() - Constructor for class org.scribble.protocol.model.ProtocolImportList

The default constructor.

ProtocolImportList(ProtocolImportList) - Constructor for class org.scribble.protocol.model.ProtocolImportList

The copy constructor.

ProtocolModel - Class in org.scribble.protocol.model

This class represents the base class for models associated with specific notations.

ProtocolModel() - Constructor for class org.scribble.protocol.model.ProtocolModel

The default constructor for the model.

ProtocolModelUtil - Class in org.scribble.protocol.util

This class provides utility functions related to the protocol model.

ProtocolParser - Interface in org.scribble.protocol.parser

This interface represents the protocol parser.

ProtocolParserManager - Interface in org.scribble.protocol.parser

This interface defines the protocol parser manager, responsible for parsing a specified input stream against a parser appropriate for the information being parsed.

ProtocolParserManagerFactory - Class in org.scribble.protocol.parser

This is the factory class for obtaining the parser manager.

ProtocolProjector - Interface in org.scribble.protocol.projection

This interface provides a projection capability, from a 'global' to 'local' model, for the protocol notation.

ProtocolReference - Class in org.scribble.protocol.model

This class represents a protocol reference.

ProtocolReference() - Constructor for class org.scribble.protocol.model.ProtocolReference

This is the default constructor for the protocol reference.

ProtocolReference(String) - Constructor for class org.scribble.protocol.model.ProtocolReference

This is the constructor for the protocol reference.

ProtocolReference(ProtocolReference) - Constructor for class org.scribble.protocol.model.ProtocolReference

This is the copy constructor for the model reference.

R

RecBlock - Class in org.scribble.protocol.model

This class represents the Recur construct.

RecBlock() - Constructor for class org.scribble.protocol.model.RecBlock

This is the default constructor.

Recursion - Class in org.scribble.protocol.model

This class represents the Raise construct.

Recursion() - Constructor for class org.scribble.protocol.model.Recursion

This is the default constructor.

Recursion(Recursion) - Constructor for class org.scribble.protocol.model.Recursion

This is the copy constructor.

remove(Activity) - Method in class org.scribble.protocol.model.Block

This method removes an activity from the block.

remove(Object) - Method in class org.scribble.protocol.model.ContainmentList

Removes the first occurrence in this list of the specified element (optional operation).

remove(int) - Method in class org.scribble.protocol.model.ContainmentList

Removes the element at the specified position in this list (optional operation).

removeAll(Collection<?>) - Method in class org.scribble.protocol.model.ContainmentList

Removes from this list all the elements that are contained in the specified collection (optional operation).

removed(ModelObject) - Method in interface org.scribble.protocol.conformance.ConformanceHandler

This method indicates that a model object within the reference model does not exist in the model being conformance checked.

removed(ModelObject) - Method in class org.scribble.protocol.conformance.LoggingConformanceHandler

This method indicates that a model object within the reference model does not exist in the model being conformance checked.

Repeat - Class in org.scribble.protocol.model

This class represents the Repeat construct.

Repeat() - Constructor for class org.scribble.protocol.model.Repeat

This is the default constructor.

RESERVED_WORDS - Static variable in class org.scribble.protocol.ProtocolDefinitions

The list of reserved workds.

retainAll(Collection<?>) - Method in class org.scribble.protocol.model.ContainmentList

Retains only the elements in this list that are contained in the specified collection (optional operation).

Role - Class in org.scribble.protocol.model

This class represents a role.

Role() - Constructor for class org.scribble.protocol.model.Role

This is the default constructor.

Role(Role) - Constructor for class org.scribble.protocol.model.Role

This is the copy constructor.

Role(String) - Constructor for class org.scribble.protocol.model.Role

This constructor initializes the role with a name.

RoleUtil - Class in org.scribble.protocol.util

This class provides utility functions related to the Role protocol component.

RoleUtil.RoleLocator - Class in org.scribble.protocol.util

Visitor for locating roles.

RoleUtil.RoleLocator(Protocol, Activity, Set<Role>) - Constructor for class org.scribble.protocol.util.RoleUtil.RoleLocator

Constructor.

Run - Class in org.scribble.protocol.model

This class represents the Run construct.

Run() - Constructor for class org.scribble.protocol.model.Run

This is the default constructor.

Run(Run) - Constructor for class org.scribble.protocol.model.Run

This is the copy constructor.

RunUtil - Class in org.scribble.protocol.util

This class provides helper functions for the Run construct.

S

set(int, E) - Method in class org.scribble.protocol.model.ContainmentList

Replaces the element at the specified position in this list with the specified element (optional operation).

setAnnotationProcessor(AnnotationProcessor) - Method in interface org.scribble.protocol.parser.ProtocolParser

This method sets an annotation processor.

setBlock(Block) - Method in class org.scribble.protocol.model.Do

This method sets the block of activities associated with the definition.

setBlock(Block) - Method in class org.scribble.protocol.model.Interrupt

This method sets the block of activities associated with the definition.

setBlock(Block) - Method in class org.scribble.protocol.model.OnMessage

This method sets the block.

setBlock(Block) - Method in class org.scribble.protocol.model.Protocol

This method sets the block of activities associated with the definition.

setBlock(Block) - Method in class org.scribble.protocol.model.RecBlock

This method sets the block.

setBlock(Block) - Method in class org.scribble.protocol.model.Repeat

This method sets the block.

setBlock(Block) - Method in class org.scribble.protocol.model.Unordered

This method sets the block.

setDataType(DataType) - Method in class org.scribble.protocol.model.TypeImport

This method sets the data type.

setDefaultGroupReturn(boolean) - Method in class org.scribble.protocol.model.DefaultVisitor

This method sets the default group construct return value.

setDetails(String) - Method in class org.scribble.protocol.model.DataType

This method sets the details.

setExporters(List<ProtocolExporter>) - Method in class org.scribble.protocol.export.DefaultProtocolExportManager

This method sets the list of exporters registered with the manager.

setExporters(List<ProtocolExporter>) - Method in interface org.scribble.protocol.export.ProtocolExportManager

This method sets the list of exporters registered with the manager.

setFormat(String) - Method in class org.scribble.protocol.model.TypeImportList

This method sets the format.

setFromRole(Role) - Method in class org.scribble.protocol.model.DirectedChoice

This method sets the from role.

setFromRole(Role) - Method in class org.scribble.protocol.model.Interaction

This method sets the optional 'from' role.

setFromRole(Role) - Method in class org.scribble.protocol.model.Run

This method sets the optional 'from' role.

setIntroducer(Role) - Method in class org.scribble.protocol.model.Introduces

This method sets the introducing role.

setLabel(String) - Method in class org.scribble.protocol.model.RecBlock

This method sets the label associated with the labelled block construct.

setLabel(String) - Method in class org.scribble.protocol.model.Recursion

This method sets the label associated with the recursion construct.

setLocatedRole(Role) - Method in class org.scribble.protocol.model.Protocol

This method sets the located role.

setLocation(String) - Method in class org.scribble.protocol.model.ProtocolImport

This method sets the location of the schema.

setLocation(String) - Method in class org.scribble.protocol.model.TypeImportList

This method sets the location of the schema.

setMessageSignature(MessageSignature) - Method in class org.scribble.protocol.model.Interaction

This method sets the message signature.

setMessageSignature(MessageSignature) - Method in class org.scribble.protocol.model.OnMessage

This method sets the message signature.

setName(String) - Method in class org.scribble.protocol.model.Parameter

This method sets the local name.

setName(String) - Method in class org.scribble.protocol.model.ParameterDefinition

This method sets the name of the parameter.

setName(String) - Method in class org.scribble.protocol.model.Protocol

This method sets the name.

setName(String) - Method in class org.scribble.protocol.model.ProtocolImport

This method sets the name of the type being imported.

setName(String) - Method in class org.scribble.protocol.model.ProtocolReference

This method sets the name associated with the model reference.

setName(String) - Method in class org.scribble.protocol.model.Role

This method sets the name of the role.

setName(String) - Method in class org.scribble.protocol.model.TypeImport

This method sets the name of the type being imported.

setName(String) - Method in class org.scribble.protocol.model.TypeReference

This method sets the name associated with the model reference.

setOperation(String) - Method in class org.scribble.protocol.model.MessageSignature

This method sets the operation.

setParent(ModelObject) - Method in class org.scribble.protocol.model.ModelObject

This method sets the parent model object.

setParsers(List<ProtocolParser>) - Method in class org.scribble.protocol.parser.DefaultProtocolParserManager

This method sets the list of protocol parsers.

setParsers(List<ProtocolParser>) - Method in interface org.scribble.protocol.parser.ProtocolParserManager

This method sets the list of protocol parsers.

setProtocol(Protocol) - Method in class org.scribble.protocol.model.ProtocolModel

This method set the definition associated with the model.

setProtocolParserManager(ProtocolParserManager) - Method in class org.scribble.protocol.DefaultProtocolContext

This method sets the protocol parser manager.

setProtocolReference(ProtocolReference) - Method in class org.scribble.protocol.model.Inline

This method sets the protocol reference associated with the run construct.

setProtocolReference(ProtocolReference) - Method in class org.scribble.protocol.model.Run

This method sets the protocol reference associated with the run construct.

setProtocolValidationManager(ProtocolValidationManager) - Method in interface org.scribble.protocol.projection.ProtocolProjector

This method sets the protocol validation manager.

setResourceLocator(ResourceLocator) - Method in class org.scribble.protocol.DefaultProtocolContext

This method sets the resource locator.

setRole(Role) - Method in class org.scribble.protocol.model.Choice

This method sets the role.

setRole(Role) - Method in class org.scribble.protocol.model.ProtocolReference

This method sets the located role.

setType(TypeReference) - Method in class org.scribble.protocol.model.ParameterDefinition

This method sets the type of the parameter.

size() - Method in class org.scribble.protocol.model.Block

This method returns the number of activities in the block.

start(Block) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a block.

start(Protocol) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a protocol.

start(Choice) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a choice.

start(DirectedChoice) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a directed choice.

start(OnMessage) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a directed choice.

start(Interrupt) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method processes an interrupt clause.

start(Parallel) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a parallel.

start(Do) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a try/escape.

start(Repeat) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a repeat.

start(Unordered) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a unordered block.

start(RecBlock) - Method in class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This method indicates the start of a labelled block.

start(Block) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a block.

start(Protocol) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a protocol.

start(Choice) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a choice.

start(DirectedChoice) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a directed choice.

start(OnMessage) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a on-message.

start(Parallel) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a parallel.

start(Repeat) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a repeat.

start(RecBlock) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a labelled block.

start(Unordered) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of an Unordered construct.

start(Do) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a try escape.

start(Interrupt) - Method in class org.scribble.protocol.model.AbstractModelObjectVisitor

This method indicates the start of a catch block.

start(Block) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a block.

start(Protocol) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a protocol.

start(Choice) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a choice.

start(DirectedChoice) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a directed choice.

start(OnMessage) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a on-message.

start(Parallel) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a parallel.

start(Repeat) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a repeat.

start(RecBlock) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a labelled block.

start(Unordered) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of an Unordered construct.

start(Do) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a try escape.

start(Interrupt) - Method in class org.scribble.protocol.model.DefaultVisitor

This method indicates the start of a catch block.

start(Block) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a block.

start(Choice) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a choice.

start(DirectedChoice) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a directed choice.

start(OnMessage) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a on-message.

start(Parallel) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a parallel.

start(Protocol) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a protocol.

start(Repeat) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a repeat.

start(RecBlock) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a labelled block.

start(Unordered) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a unordered block.

start(Do) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a try escape.

start(Interrupt) - Method in interface org.scribble.protocol.model.Visitor

This method indicates the start of a catch block.

start(Protocol) - Method in class org.scribble.protocol.util.InteractionUtil.InitialInteractionVisitor

start(Choice) - Method in class org.scribble.protocol.util.InteractionUtil.InitialInteractionVisitor

start(Block) - Method in class org.scribble.protocol.util.InteractionUtil.InitialInteractionVisitor

start(Block) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(Choice) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(DirectedChoice) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(OnMessage) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(Unordered) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(Parallel) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(Protocol) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(Repeat) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(RecBlock) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(Do) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

start(Interrupt) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

START_LOCATION - Static variable in interface org.scribble.protocol.model.ModelProperties

This construct defines the start location in a textual description of a scribble construct.

startBlock(Block) - Method in class org.scribble.protocol.util.RoleUtil.RoleLocator

Indicates the start of a block.

T

TEXT_ID - Static variable in class org.scribble.protocol.export.text.TextProtocolExporter

Export id for text.

TextProtocolExporter - Class in org.scribble.protocol.export.text

This class provides a text based exporter for the protocol.

TextProtocolExporter() - Constructor for class org.scribble.protocol.export.text.TextProtocolExporter

TextProtocolExporterVisitor - Class in org.scribble.protocol.export.text

This class provides a protocol visitor used to export a text based representation of a protocol.

TextProtocolExporterVisitor(Journal, OutputStream) - Constructor for class org.scribble.protocol.export.text.TextProtocolExporterVisitor

This is the visitor for the text based protocol export.

toString() - Method in class org.scribble.protocol.model.Block

toString() - Method in class org.scribble.protocol.model.Choice

toString() - Method in class org.scribble.protocol.model.DirectedChoice

toString() - Method in class org.scribble.protocol.model.Interaction

toString() - Method in class org.scribble.protocol.model.Introduces

toString() - Method in class org.scribble.protocol.model.MessageSignature

toString() - Method in class org.scribble.protocol.model.ParameterDefinition

toString() - Method in class org.scribble.protocol.model.ProtocolImport

toString() - Method in class org.scribble.protocol.model.RecBlock

toString() - Method in class org.scribble.protocol.model.Recursion

toString() - Method in class org.scribble.protocol.model.Role

toString() - Method in class org.scribble.protocol.model.TypeImport

toString() - Method in class org.scribble.protocol.model.TypeReference

TypeImport - Class in org.scribble.protocol.model

This class represents an imported type associated with a model.

TypeImport() - Constructor for class org.scribble.protocol.model.TypeImport

The default constructor.

TypeImport(TypeImport) - Constructor for class org.scribble.protocol.model.TypeImport

The copy constructor.

TypeImportList - Class in org.scribble.protocol.model

This class represents an import definition associated with a model.

TypeImportList() - Constructor for class org.scribble.protocol.model.TypeImportList

The default constructor.

TypeImportList(TypeImportList) - Constructor for class org.scribble.protocol.model.TypeImportList

The copy constructor.

TypeReference - Class in org.scribble.protocol.model

This class represents a type reference.

TypeReference() - Constructor for class org.scribble.protocol.model.TypeReference

This is the default constructor for the type reference.

TypeReference(TypeReference) - Constructor for class org.scribble.protocol.model.TypeReference

This is the copy constructor for the type reference.

TypeReference(String) - Constructor for class org.scribble.protocol.model.TypeReference

This is the constructor for the type reference.

TypesUtil - Class in org.scribble.protocol.util

Helper functions for dealing with protocol types.

U

Unordered - Class in org.scribble.protocol.model

This class represents the Unordered construct.

Unordered() - Constructor for class org.scribble.protocol.model.Unordered

This is the default constructor.

updated(ModelObject, ModelObject) - Method in interface org.scribble.protocol.conformance.ConformanceHandler

This method indicates that a change has been detected between equivalent model objects found in the primary and reference models.

updated(ModelObject, ModelObject) - Method in class org.scribble.protocol.conformance.LoggingConformanceHandler

This method indicates that a change has been detected between equivalent model objects found in the primary and reference models.

V

visit(Visitor) - Method in class org.scribble.protocol.model.Block

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Choice

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.DataType

This method visits the data type.

visit(Visitor) - Method in class org.scribble.protocol.model.DirectedChoice

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Do

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.End

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Inline

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Interaction

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Interrupt

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Introduces

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.MessageSignature

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.ModelObject

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.OnMessage

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Parallel

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Parameter

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.ParameterDefinition

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Protocol

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.ProtocolImport

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.ProtocolImportList

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.ProtocolModel

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.ProtocolReference

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.RecBlock

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Recursion

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Repeat

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Role

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Run

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.TypeImport

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.TypeImportList

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.TypeReference

This method visits the model object using the supplied visitor.

visit(Visitor) - Method in class org.scribble.protocol.model.Unordered

This method visits the model object using the supplied visitor.

Visitor - Interface in org.scribble.protocol.model

This interface represents a visitor which can be used to traverse a model.

A B C D E G H I L M O P R S T U V