Package com.topologi.diffx.event.impl

Class SpaceEvent

java.lang.Object

com.topologi.diffx.event.impl.DiffXEventBase

com.topologi.diffx.event.impl.CharactersEventBase

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

Field Summary

Fields

Modifier and Type	Field	Description
static final SpaceEvent	DOUBLE_WHITESPACE	A static instance for the double white spaces.
static final SpaceEvent	NEW_LINE	A static instance for the new lines.
static final SpaceEvent	SINGLE_WHITESPACE	A static instance for the single white spaces.
static final SpaceEvent	TAB	A static instance for tabs.

Fields inherited from class com.topologi.diffx.event.impl.DiffXEventBase

ESC, weight

Constructor Summary

Constructors

Constructor	Description
SpaceEvent(CharSequence w)	Creates a new word event.

Method Summary

Modifier and Type	Method	Description
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.
String	toString()
private static String	toString(char[] chars)	Returns the white space characters as a readable string.

Methods inherited from class com.topologi.diffx.event.impl.CharactersEventBase

equals, getCharacters, hashCode, toXML, toXML

Methods inherited from class com.topologi.diffx.event.impl.DiffXEventBase

equals, getWeight, setWeight, toXML

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.topologi.diffx.event.DiffXEvent

equals, getWeight, setWeight

Methods inherited from interface com.topologi.diffx.event.TextEvent

getCharacters

Methods inherited from interface com.topologi.diffx.xml.XMLFormattable

toXML, toXML

Methods inherited from interface com.topologi.diffx.xml.XMLWritable

toXML

Field Details

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 Details

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 Details

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.

toString

private static String toString(char[] chars)

Returns the white space characters as a readable string.

Parameters:

chars - The whitespace characters

Returns:

A readable string.