|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.topologi.diffx.event.impl.CommentEvent
public final class CommentEvent
A comment event.
Constructor Summary | |
---|---|
CommentEvent(String comment)
Creates a new comment event. |
Method Summary | |
---|---|
boolean |
equals(DiffXEvent e)
Returns true if the event is a comment event. |
boolean |
equals(Object o)
Invokes the DiffXEvent.equals(DiffXEvent) method if the specified object if not
null and is an instance of DiffXEvent . |
String |
getComment()
Returns the comment. |
int |
getWeight()
Returns the weight of this event. |
int |
hashCode()
|
void |
setWeight(int weight)
Sets the weight of this event. |
String |
toString()
|
String |
toXML()
Returns a xml representation of the object of the implementing class. |
StringBuffer |
toXML(StringBuffer xml)
Appends the XML representation of the object of the implementing class. |
void |
toXML(XMLWriter xml)
Writes the XML representation of the implementing instance using the specified XMLWriter . |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.topologi.diffx.event.DiffXEvent |
---|
getWeight, setWeight |
Methods inherited from interface com.topologi.diffx.xml.XMLFormattable |
---|
toXML |
Constructor Detail |
---|
public CommentEvent(String comment) throws NullPointerException
comment
- the comment string.
NullPointerException
- if any of the argument is null
.Method Detail |
---|
public String getComment()
public int hashCode()
public boolean equals(DiffXEvent e)
true
if the event is a comment event.
equals
in interface DiffXEvent
e
- The event to compare with this event.
true
if this event is equal to the specified event;
false
otherwise.public String toString()
toString
in class Object
public void toXML(XMLWriter xml) throws IOException
XMLWritable
XMLWriter
.
toXML
in interface XMLWritable
xml
- The XMLWriter to use.
IOException
- IF an I/O exception occurs whilst writing.public StringBuffer toXML(StringBuffer xml)
XMLFormattable
Implementations must ensure that the returned string buffer is the same object as the specified string buffer.
toXML
in interface XMLFormattable
xml
- The string buffer to which the XML representation is appended to.
public final boolean equals(Object o)
DiffXEvent.equals(DiffXEvent)
method if the specified object if not
null
and is an instance of DiffXEvent
.
equals
in class Object
o
- The object to compare.
true
if the specified object is equal;
false
otherwise.public String toXML()
XMLFormattable
Returns a xml representation of the object of the implementing class.
Most implementation should use the following code to ensure consistent data with the
other toXML
method:
return this.toXML(new StringBuffer()).toString();
toXML
in interface XMLFormattable
public int getWeight()
DiffXEvent
The default weight should be 1.
getWeight
in interface DiffXEvent
public void setWeight(int weight)
DiffXEvent
This method is intended for use by algorithms, optimisers and loaders in order to adjust the importance of an event.
setWeight
in interface DiffXEvent
weight
- The weight of this event.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |