com.topologi.diffx.event.impl
Class WordEvent

java.lang.Object
  com.topologi.diffx.event.impl.CharactersEventBase
      com.topologi.diffx.event.impl.WordEvent

All Implemented Interfaces:

DiffXEvent, TextEvent, XMLFormattable, XMLWritable

public final class WordEvent
extends CharactersEventBase
implements TextEvent

A text event representing a word.

Version:

27 March 2010

Author:

Christophe Lauret

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

WordEvent

public WordEvent(CharSequence w)
          throws NullPointerException

Creates a new word event.

Parameters:

w - The word as a string.

Throws:

NullPointerException - If the given String is null.

Method Detail

toString

public String toString()

Overrides:

toString in class Object

equals

public final boolean equals(Object o)

Invokes the DiffXEvent.equals(DiffXEvent) method if the specified object if not null and is an instance of DiffXEvent.

Overrides:

equals in class Object

Parameters:

o - The object to compare.

Returns:

true if the specified object is equal; false otherwise.

toXML

public String toXML()

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();

Specified by:

toXML in interface XMLFormattable

Returns:

a XML representation of the object of the implementing class.

getWeight

public int getWeight()

Returns the weight of this event.

The default weight should be 1.

Specified by:

getWeight in interface DiffXEvent

Returns:

The weight of this event.

setWeight

public void setWeight(int weight)

Sets the weight of this event.

This method is intended for use by algorithms, optimisers and loaders in order to adjust the importance of an event.

Specified by:

setWeight in interface DiffXEvent

Parameters:

weight - The weight of this event.