com.topologi.diffx.event.impl
Class OpenElementEventNSImpl

java.lang.Object
  extended bycom.topologi.diffx.event.impl.DiffXEventBase
      extended bycom.topologi.diffx.event.impl.OpenElementEventNSImpl
All Implemented Interfaces:
DiffXEvent, OpenElementEvent, XMLFormattable, XMLWritable

public final class OpenElementEventNSImpl
extends com.topologi.diffx.event.impl.DiffXEventBase
implements DiffXEvent, OpenElementEvent

The event corresponding to the startElement SAX event.

Version:
23 December 2004
Author:
Christophe Lauret

Constructor Summary
OpenElementEventNSImpl(String name)
          Creates a new open element event with the default URI.
OpenElementEventNSImpl(String uri, String name)
          Creates a new open element event.
 
Method Summary
 boolean equals(DiffXEvent e)
          Returns true if the event is a
 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 element.
 String getURI()
          Returns the namespace URI the element belongs to.
 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)
          Converts this event to an XML open tag.
 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
 
Methods inherited from interface com.topologi.diffx.event.DiffXEvent
getWeight, setWeight
 
Methods inherited from interface com.topologi.diffx.xml.XMLFormattable
toXML
 

Constructor Detail

OpenElementEventNSImpl

public OpenElementEventNSImpl(String name)
                       throws NullPointerException
Creates a new open element event with the default URI.

Parameters:
name - The local name of the element
Throws:
NullPointerException - if the name is null.
See Also:
Constants.DEFAULT_URI

OpenElementEventNSImpl

public OpenElementEventNSImpl(String uri,
                              String name)
                       throws NullPointerException
Creates a new open element event.

Parameters:
uri - The namespace URI of the element
name - The local name of the element
Throws:
NullPointerException - if any of the argument is null.
Method Detail

getName

public String getName()
Description copied from interface: OpenElementEvent
Returns the local name of the element.

Specified by:
getName in interface OpenElementEvent
Returns:
Returns the name.

getURI

public String getURI()
Description copied from interface: OpenElementEvent
Returns the namespace URI the element belongs to.

Specified by:
getURI in interface OpenElementEvent
Returns:
Returns the uri.

hashCode

public int hashCode()
See Also:
Object.hashCode()

equals

public boolean equals(DiffXEvent e)
Returns true if the event is a

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.
See Also:
DiffXEvent.equals(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.

Specified by:
toXML in interface XMLWritable
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)
Converts this event to an XML open tag.

Note that this method does not allow attributes to be put after this element.

Specified by:
toXML in interface XMLFormattable
Parameters:
xml - The string buffer to which the XML representation is appended to.
Returns:
The modified string buffer.
See Also:
XMLFormattable.toXML(java.lang.StringBuffer)

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)