dom4j 2.1.4 · org.dom4j.util.NodeComparator

Access	Constructor and Description
public	NodeComparator()

Modifier and Type	Method and Description
public int	compare(Node the first object to be compared. n1, Node the second object to be compared. n2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(Document the first object to be compared. n1, Document the second object to be compared. n2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(Element the first object to be compared. n1, Element the second object to be compared. n2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(Attribute the first object to be compared. n1, Attribute the second object to be compared. n2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(QName the first object to be compared. n1, QName the second object to be compared. n2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(Namespace the first object to be compared. n1, Namespace the second object to be compared. n2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(CharacterData the first object to be compared. t1, CharacterData the second object to be compared. t2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(DocumentType the first object to be compared. o1, DocumentType the second object to be compared. o2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(Entity the first object to be compared. n1, Entity the second object to be compared. n2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(ProcessingInstruction the first object to be compared. n1, ProcessingInstruction the second object to be compared. n2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compare(String the first object to be compared. o1, String the second object to be compared. o2) Implements java.util.Comparator.compare. Compares its two arguments for order.
public int	compareContent(Branch b1, Branch b2)

NodeComparator	back to summary
public NodeComparator()

Method Detail

compare back to summary

compare	back to summary
public int compare(Node n1, Node n2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters n1:Node the first object to be compared. n2:Node the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(Node n1, Node n2)

Implements java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must ensure that signum(compare(x, y)) == -signum(compare(y, x)) for all x and y. (This implies that compare(x, y) must throw an exception if and only if compare(y, x) throws an exception.)

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

n1:Node: the first object to be compared.
n2:Node: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(Document n1, Document n2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters n1:Document the first object to be compared. n2:Document the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(Document n1, Document n2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

n1:Document: the first object to be compared.
n2:Document: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(Element n1, Element n2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters n1:Element the first object to be compared. n2:Element the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(Element n1, Element n2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

n1:Element: the first object to be compared.
n2:Element: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(Attribute n1, Attribute n2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters n1:Attribute the first object to be compared. n2:Attribute the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(Attribute n1, Attribute n2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

n1:Attribute: the first object to be compared.
n2:Attribute: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(QName n1, QName n2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters n1:QName the first object to be compared. n2:QName the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(QName n1, QName n2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

n1:QName: the first object to be compared.
n2:QName: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(Namespace n1, Namespace n2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters n1:Namespace the first object to be compared. n2:Namespace the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(Namespace n1, Namespace n2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

n1:Namespace: the first object to be compared.
n2:Namespace: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(CharacterData t1, CharacterData t2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters t1:CharacterData the first object to be compared. t2:CharacterData the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(CharacterData t1, CharacterData t2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

t1:CharacterData: the first object to be compared.
t2:CharacterData: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(DocumentType o1, DocumentType o2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters o1:DocumentType the first object to be compared. o2:DocumentType the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(DocumentType o1, DocumentType o2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

o1:DocumentType: the first object to be compared.
o2:DocumentType: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(Entity n1, Entity n2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters n1:Entity the first object to be compared. n2:Entity the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(Entity n1, Entity n2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

n1:Entity: the first object to be compared.
n2:Entity: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(ProcessingInstruction n1, ProcessingInstruction n2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters n1:ProcessingInstruction the first object to be compared. n2:ProcessingInstruction the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(ProcessingInstruction n1, ProcessingInstruction n2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

n1:ProcessingInstruction: the first object to be compared.
n2:ProcessingInstruction: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compare back to summary

compare	back to summary
public int compare(String o1, String o2) Implements java.util.Comparator.compare. Doc from java.util.Comparator.compare. Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second. The implementor must ensure that `signum(compare(x, y)) == -signum(compare(y, x))` for all `x` and `y`. (This implies that `compare(x, y)` must throw an exception if and only if `compare(y, x)` throws an exception.) The implementor must also ensure that the relation is transitive: `((compare(x, y)>0) && (compare(y, z)>0))` implies `compare(x, z)>0`. Finally, the implementor must ensure that `compare(x, y)==0` implies that `signum(compare(x, z))==signum(compare(y, z))` for all `z`. Parameters o1:String the first object to be compared. o2:String the second object to be compared. Returns:int a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

public int compare(String o1, String o2)

Implements java.util.Comparator.compare.

Doc from java.util.Comparator.compare.

Compares its two arguments for order. Returns a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

The implementor must also ensure that the relation is transitive: ((compare(x, y)>0) && (compare(y, z)>0)) implies compare(x, z)>0.

Finally, the implementor must ensure that compare(x, y)==0 implies that signum(compare(x, z))==signum(compare(y, z)) for all z.

Parameters

o1:String: the first object to be compared.
o2:String: the second object to be compared.

Returns:int

a negative integer, zero, or a positive integer as the first argument is less than, equal to, or greater than the second.

compareContent	back to summary
public int compareContent(Branch b1, Branch b2)

public Class NodeComparator

Constructor Summary

Method Summary

Constructor Detail

Method Detail