com.topologi.diffx.event.impl
Class SpaceEvent

java.lang.Object
  extended by com.topologi.diffx.event.impl.CharactersEventBase
      extended by com.topologi.diffx.event.impl.SpaceEvent
All Implemented Interfaces:
DiffXEvent, TextEvent, XMLFormattable, XMLWritable

public final class SpaceEvent
extends CharactersEventBase
implements TextEvent

A particular type of event reserved for white spaces.

Version:
27 March 2010
Author:
Christophe Lauret

Field Summary
static SpaceEvent DOUBLE_WHITESPACE
          A static instance for the double white spaces.
static SpaceEvent NEW_LINE
          A static instance for the new lines.
static SpaceEvent SINGLE_WHITESPACE
          A static instance for the single white spaces.
static SpaceEvent TAB
          A static instance for tabs.
 
Constructor Summary
SpaceEvent(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.
static SpaceEvent getInstance(char c)
          Returns the white space event corresponding to the given string.
static SpaceEvent getInstance(CharSequence space)
          Returns the white space event corresponding to the given string.
 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
 

Field Detail

SINGLE_WHITESPACE

public static final SpaceEvent SINGLE_WHITESPACE
A static instance for the single white spaces.

Use this constant instead of creating new instances


DOUBLE_WHITESPACE

public static final SpaceEvent DOUBLE_WHITESPACE
A static instance for the double white spaces.

Use this constant instead of creating new instances


NEW_LINE

public static final SpaceEvent NEW_LINE
A static instance for the new lines.

Use this constant instead of creating new instances


TAB

public static final SpaceEvent TAB
A static instance for tabs.

Use this constant instead of creating new instances

Constructor Detail

SpaceEvent

public SpaceEvent(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

getInstance

public static SpaceEvent getInstance(CharSequence space)
Returns the white space event corresponding to the given string.

Parameters:
space - The string for the white space event.
Returns:
A readable string.

getInstance

public static SpaceEvent getInstance(char c)
Returns the white space event corresponding to the given string.

Parameters:
c - The string for the white space event.
Returns:
A readable string.

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()
Description copied from interface: 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();

Specified by:
toXML in interface XMLFormattable
Returns:
a XML representation of the object of the implementing class.

getWeight

public int getWeight()
Description copied from interface: DiffXEvent
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)
Description copied from interface: DiffXEvent
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.