com.topologi.diffx.event.impl

Class AttributeEventNSImpl

java.lang.Object

com.topologi.diffx.event.impl.AttributeEventNSImpl

All Implemented Interfaces:

AttributeEvent, DiffXEvent, XMLFormattable, XMLWritable

public final class AttributeEventNSImpl
extends Object
implements AttributeEvent

A namespace aware implementation of the attribute event.

Version:

28 March 2010

Author:

Christophe Lauret, Jean-Baptiste Reure

Constructor Summary

Constructors

Constructor and Description
AttributeEventNSImpl(String name, String value) Creates a new attribute event.
AttributeEventNSImpl(String uri, String name, String value) Creates a new attribute event.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(DiffXEvent e) Returns true if the event is an attribute event.
boolean	equals(Object o) Invokes the DiffXEvent.equals(DiffXEvent) method if the specified object if not null and is an instance of DiffXEvent.
String	getName() Returns the local name of the attribute.
String	getURI() Returns the namespace URI the attribute belongs to.
String	getValue() Returns the value of the attribute.
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

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

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

getWeight, setWeight

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

toXML

Constructor Detail

AttributeEventNSImpl

public AttributeEventNSImpl(String name,
                    String value)
                     throws NullPointerException

Creates a new attribute event.

Parameters:

name - The local name of the attribute.

value - The value of the attribute.

Throws:

NullPointerException - if any of the argument is null.

AttributeEventNSImpl

public AttributeEventNSImpl(String uri,
                    String name,
                    String value)
                     throws NullPointerException

Creates a new attribute event.

Parameters:

uri - The uri of the attribute.

name - The local name of the attribute.

value - The value of the attribute.

Throws:

NullPointerException - if any of the argument is null.

Method Detail

getName

public String getName()

Returns the local name of the attribute.

This method should never return null.

Specified by:

getName in interface AttributeEvent

Returns:

The local name of the attribute.

getURI

public String getURI()

Returns the namespace URI the attribute belongs to.

This method should return null if the implementation is not namespace aware or if the attribute is not bound to any namespace.

Specified by:

getURI in interface AttributeEvent

Returns:

The namespace URI the attribute belongs to or null.

getValue

public String getValue()

Returns the value of the attribute.

This method should never return null.

Specified by:

getValue in interface AttributeEvent

Returns:

The value of the attribute.

hashCode

public int hashCode()

equals

public boolean equals(DiffXEvent e)

Returns true if the event is an attribute event.

Specified by:

equals in interface DiffXEvent

Parameters:

e - The event to compare with this event.

Returns:

true if this event is equal to the specified event; false otherwise.

toString

public String toString()

Overrides:

toString in class Object

toXML

public void toXML(XMLWriter xml)
           throws IOException

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

Specified by:

toXML in interface XMLWritable

Parameters:

xml - The XMLWriter to use.

Throws:

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

toXML

public StringBuffer toXML(StringBuffer xml)
                   throws NullPointerException

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.

Specified by:

toXML in interface XMLFormattable

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.

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.