|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.topologi.diffx.event.impl.CharactersEventBase com.topologi.diffx.event.impl.WordEvent
public final class WordEvent
A text event representing a word.
Constructor Summary | |
---|---|
WordEvent(CharSequence w)
Creates a new word event. |
Method Summary | |
---|---|
boolean |
equals(Object o)
Invokes the DiffXEvent.equals(DiffXEvent) method if the specified object if not
null and is an instance of DiffXEvent . |
int |
getWeight()
Returns the weight of this event. |
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. |
Methods inherited from class com.topologi.diffx.event.impl.CharactersEventBase |
---|
equals, getCharacters, hashCode, toXML, toXML |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.topologi.diffx.event.TextEvent |
---|
getCharacters |
Methods inherited from interface com.topologi.diffx.event.DiffXEvent |
---|
equals, getWeight, setWeight |
Methods inherited from interface com.topologi.diffx.xml.XMLWritable |
---|
toXML |
Methods inherited from interface com.topologi.diffx.xml.XMLFormattable |
---|
toXML, toXML |
Constructor Detail |
---|
public WordEvent(CharSequence w) throws NullPointerException
w
- The word as a string.
NullPointerException
- If the given String is null
.Method Detail |
---|
public String toString()
toString
in class Object
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 |