Returns the Comparator used.

Exceptions

UnsupportedOperationException:

if comparator is not defined

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

obj:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

Returns an instance which specifies that insertion ordering is guaranteed.

Returns an instance which specifies that the natural ordering of the elements is guaranteed.

Returns an instance which specifies that the ordering of the elements is guaranteed to be determined by comparator.

Returns an instance which specifies that ordering is guaranteed to be always be the same across iterations, and across releases. Some methods may have stronger guarantees.

This instance is only useful in combination with incidentEdgeOrder, e.g. graphBuilder.incidentEdgeOrder(ElementOrder.stable()).

In combination with incidentEdgeOrder

incidentEdgeOrder(ElementOrder.stable()) guarantees the ordering of the returned collections of the following methods:

• For Graph and ValueGraph:
  • edges(): Stable order
  • adjacentNodes(node): Connecting edge insertion order
  • predecessors(node): Connecting edge insertion order
  • successors(node): Connecting edge insertion order
  • incidentEdges(node): Edge insertion order
• For Network:
  • adjacentNodes(node): Stable order
  • predecessors(node): Connecting edge insertion order
  • successors(node): Connecting edge insertion order
  • incidentEdges(node): Stable order
  • inEdges(node): Edge insertion order
  • outEdges(node): Edge insertion order
  • adjacentEdges(edge): Stable order
  • edgesConnecting(nodeU, nodeV): Edge insertion order

Since

29.0

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

Returns the type of ordering used.

Returns an instance which specifies that no ordering is guaranteed.