|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.topologi.diffx.event.impl.XMLBranchEvent
public final class XMLBranchEvent
A branch of XML data.
A branch of XML data must start and end with the same element.
Implementation note: this class wraps an array of DiffX events and does not give access to this array, so it can be considered immutable.
Constructor Summary | |
---|---|
XMLBranchEvent(DiffXEvent[] events)
Creates a new XML branch. |
Method Summary | |
---|---|
boolean |
equals(DiffXEvent e)
Returns true if the diffX events in the branch are all equal. |
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 |
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)
Write the DiffX events in order. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, 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 |
---|
public XMLBranchEvent(DiffXEvent[] events)
events
- The array of events that make up the branch.Method Detail |
---|
public int hashCode()
public boolean equals(DiffXEvent e)
true
if the diffX events in the branch are all equal.
Indicates whether the specified event is equal to this event.
equals
in interface DiffXEvent
e
- The event to compare it with thsi one.
true
if considered equals;
false
otherwise.public void toXML(XMLWriter xml) throws IOException
XMLWriter
.
toXML
in interface XMLWritable
xml
- The XMLWriter to use.
IOException
- IF an I/O exception occurs whilst writing.public StringBuffer toXML(StringBuffer xml) throws NullPointerException
XMLFormattable
Implementations must ensure that the returned string buffer is the same object as the specified string buffer.
toXML
in interface XMLFormattable
xml
- The string buffer to which the XML representation is appended to.
NullPointerException
- if the specified character sequence is null
.public final boolean equals(Object o)
DiffXEvent.equals(DiffXEvent)
method if the specified object if not
null
and is an instance of DiffXEvent
.
equals
in class Object
o
- The object to compare.
true
if the specified object is equal;
false
otherwise.public String toXML()
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();
toXML
in interface XMLFormattable
public int getWeight()
DiffXEvent
The default weight should be 1.
getWeight
in interface DiffXEvent
public void setWeight(int weight)
DiffXEvent
This method is intended for use by algorithms, optimisers and loaders in order to adjust the importance of an event.
setWeight
in interface DiffXEvent
weight
- The weight of this event.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |