laser.util
Interface Annotation

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
EventAlphabetTest.MockIntegerAnnotation, EventAlphabetTest.MockStringAnnotation, SourceInfo

public interface Annotation
extends java.io.Serializable

The Annotation interface represents a user-defined annotation.

Annotations are associated with Annotatable Objects.

CONSIDER: Re-add implements Cloneable.

Author:
Heather M. Conboy (laser-software@cs.umass.edu), Nathan A. Jokel
See Also:
Annotatable

Method Summary
 Annotation copyAnnotation(Annotatable container)
          Copies this Annotation and associates the copy with the specified Annotatable Object.
 java.util.Collection<Annotation> createAnnotationCollection()
          Creates an appropriate new empty Collection of Annotations.
 boolean equals(java.lang.Object obj2)
          Returns true if this Object and the given Object are equal and false otherwise.
 java.lang.String toString()
          Returns a String representation of this Object.
 

Method Detail

createAnnotationCollection

java.util.Collection<Annotation> createAnnotationCollection()
Creates an appropriate new empty Collection of Annotations.

Returns:
The appropriate new empty Collection of Annotation

copyAnnotation

Annotation copyAnnotation(Annotatable container)
Copies this Annotation and associates the copy with the specified Annotatable Object.

Parameters:
container - The Annotatable Object that the copied Annotation will be associated with.
Returns:
A reference to the copy of this Annotation that is associated with the specified Annotatable Object.

equals

boolean equals(java.lang.Object obj2)
Returns true if this Object and the given Object are equal and false otherwise.

Overrides:
equals in class java.lang.Object
Parameters:
obj2 - The given Object
Returns:
True if this Object equals the given Object and false otherwise

toString

java.lang.String toString()
Returns a String representation of this Object.

Overrides:
toString in class java.lang.Object
Returns:
A String representation of this Object