com.topologi.diffx.event.impl
Class CharEvent

java.lang.Object
  com.topologi.diffx.event.impl.DiffXEventBase
      com.topologi.diffx.event.impl.CharEvent

All Implemented Interfaces:

DiffXEvent, XMLFormattable, XMLWritable

public final class CharEvent

extends com.topologi.diffx.event.impl.DiffXEventBase

Event corresponding to a single character.

Version:

10 December 2004

Author:

Christophe Lauret (Allette Systems)

Field Summary

char	c The character associated with this event.

Constructor Summary

CharEvent(char c)
Creates a new character event.

Method Summary

boolean	equals(DiffXEvent e) Implementation must implement this method.
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.
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

Field Detail

c

public final char c

The character associated with this event.

Constructor Detail

CharEvent

public CharEvent(char c)

Creates a new character event.

Parameters:

c - The character to wrap.

Method Detail

hashCode

public int hashCode()

See Also:

DiffXEventBase.hashCode()

equals

public boolean equals(DiffXEvent e)

Description copied from class: com.topologi.diffx.event.impl.DiffXEventBase

Implementation must implement this method.

See Also:

DiffXEventBase.equals(com.topologi.diffx.event.DiffXEvent)

toString

public String toString()

See Also:

Object.toString()

toXML

public void toXML(XMLWriter xml)
           throws IOException

Description copied from interface: XMLWritable

Writes the XML representation of the implementing instance using the specified XMLWriter.

Parameters:

xml - The XMLWriter to use.

Throws:

IOException - IF an I/O exception occurs whilst writing.

See Also:

XMLWritable.toXML(com.topologi.diffx.xml.XMLWriter)

toXML

public StringBuffer toXML(StringBuffer xml)
                   throws NullPointerException

Description copied from interface: XMLFormattable

Appends the XML representation of the object of the implementing class.

Implementations must ensure that the returned string buffer is the same object as the specified string buffer.

Parameters:

xml - The string buffer to which the XML representation is appended to.

Returns:

The modified string buffer.

Throws:

NullPointerException - if the specified character sequence is null.

See Also:

XMLWritable.toXML(com.topologi.diffx.xml.XMLWriter)

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.

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.

See Also:

XMLFormattable.toXML()

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.

See Also:

DiffXEvent.getWeight()

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.

See Also:

DiffXEvent.setWeight(int)