ModelObject (Scribble::Docs::Javadoc 0.3.0.Final API)

java.lang.Object
- org.scribble.model.ModelObject

Direct Known Subclasses:

Argument, GActivity, GInterruptible.Interrupt, ImportDecl, LActivity, LInterruptible.Catch, LInterruptible.Throw, Message, MessageSignature, Module, Parameter, ParameterDecl, PayloadElement, PayloadTypeDecl, ProtocolDecl, Role, RoleDecl, RoleInstantiation
```
public abstract class ModelObject
extends Object
```
This is the generic object from which all Scribble model objects are derived.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`END_COLUMN` The end column in the document at which the issue has been detected.
`static String`	`END_LINE` The end line in the document at which the issue has been detected.
`static String`	`END_POSITION` The end position in the document at which the issue has been detected.
`static String`	`RESOURCE_URL` The optional resource URL associated with the issue.
`static String`	`START_COLUMN` The start column in the document at which the issue has been detected.
`static String`	`START_LINE` The start line in the document at which the issue has been detected.
`static String`	`START_POSITION` The start position in the document at which the issue has been detected.

Constructor Summary

Constructors
Constructor and Description

ModelObject()
This is the default constructor for the model object.

ModelObject(ModelObject obj)
This is the copy constructor.

Constructors
Constructor and Description
`ModelObject()` This is the default constructor for the model object.
`ModelObject(ModelObject obj)` This is the copy constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`derivedFrom(ModelObject modelObj)` This method establishes the necessary information to indicate that the current model object is derived from the supplied source model object.
`Module`	`getModule()` This method returns the protocol model in which this object is contained.
`ModelObject`	`getParent()` This method returns the parent of this model object.
`<T extends ModelObject> T`	`getParent(Class<T> type)` This method returns the parent with the specified type.
`Map<String,Object>`	`getProperties()` This method returns the properties associated with this model object.
`protected static void`	`indent(StringBuffer buf, int level)` This method indents the text.
`void`	`setParent(ModelObject parent)` This method sets the parent model object.
`abstract void`	`toText(StringBuffer buf, int level)` This method generates a text representation of the protocol component.
`abstract void`	`visit(Visitor visitor)` This method visits the model object using the supplied visitor.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - START_LINE
```
public static final String START_LINE
```
    The start line in the document at which the issue has been detected.
    
    See Also:
    Constant Field Values
  - START_COLUMN
```
public static final String START_COLUMN
```
    The start column in the document at which the issue has been detected.
    
    See Also:
    Constant Field Values
  - END_LINE
```
public static final String END_LINE
```
    The end line in the document at which the issue has been detected.
    
    See Also:
    Constant Field Values
  - END_COLUMN
```
public static final String END_COLUMN
```
    The end column in the document at which the issue has been detected.
    
    See Also:
    Constant Field Values
  - START_POSITION
```
public static final String START_POSITION
```
    The start position in the document at which the issue has been detected.
    
    See Also:
    Constant Field Values
  - END_POSITION
```
public static final String END_POSITION
```
    The end position in the document at which the issue has been detected.
    
    See Also:
    Constant Field Values
  - RESOURCE_URL
```
public static final String RESOURCE_URL
```
    The optional resource URL associated with the issue.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - ModelObject
```
public ModelObject()
```
    This is the default constructor for the model object.
  - ModelObject
```
public ModelObject(ModelObject obj)
```
    This is the copy constructor.
    
    Parameters:
    obj - The object to copy
- Method Detail
  - getParent
```
public ModelObject getParent()
```
    This method returns the parent of this model object.
    
    Returns:
    The parent, or null if top model object
  - getParent
```
public <T extends ModelObject> T getParent(Class<T> type)
```
    This method returns the parent with the specified type.
    
    Parameters:
    type - The class of the required parent
    
    Returns:
    The appropriate parent, or null if not found
  - setParent
```
public void setParent(ModelObject parent)
```
    This method sets the parent model object.
    
    Parameters:
    parent - The parent
  - derivedFrom
```
public void derivedFrom(ModelObject modelObj)
```
    This method establishes the necessary information to indicate that the current model object is derived from the supplied source model object.
    
    Parameters:
    modelObj - The source model object
  - getProperties
```
public Map<String,Object> getProperties()
```
    This method returns the properties associated with this model object.
    
    Returns:
    The properties
  - getModule
```
public Module getModule()
```
    This method returns the protocol model in which this object is contained.
    
    Returns:
    The protocol model, or null if not found
  - visit
```
public abstract void visit(Visitor visitor)
```
    This method visits the model object using the supplied visitor.
    
    Parameters:
    visitor - The visitor
  - toText
```
public abstract void toText(StringBuffer buf,
          int level)
```
    This method generates a text representation of the protocol component.
    
    Parameters:
    buf - The text buffer
    level - The indentation level, if relevant
  - indent
```
protected static void indent(StringBuffer buf,
          int level)
```
    This method indents the text.
    
    Parameters:
    buf - The buffer
    level - The indentation level

Class ModelObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

START_LINE

START_COLUMN

END_LINE

END_COLUMN

START_POSITION

END_POSITION

RESOURCE_URL

Constructor Detail

ModelObject

ModelObject

Method Detail

getParent

getParent

setParent

derivedFrom

getProperties

getModule

visit

toText

indent