Class ElementOrder<T>
- java.lang.Object
-
- com.google.common.graph.ElementOrder<T>
-
@Beta @Immutable public final class ElementOrder<T> extends Object
Used to represent the order of elements in a data structure that supports different options for iteration order guarantees.Example usage:
MutableGraph<Integer> graph = GraphBuilder.directed().nodeOrder(ElementOrder.<Integer>natural()).build();
- Since:
- 20.0
- Author:
- Joshua O'Madadhain
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ElementOrder.Type
The type of ordering that this object specifies.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Comparator<T>
comparator()
Returns theComparator
used.boolean
equals(Object obj)
Indicates whether some other object is "equal to" this one.int
hashCode()
Returns a hash code value for the object.static <S> ElementOrder<S>
insertion()
Returns an instance which specifies that insertion ordering is guaranteed.static <S extends Comparable<? super S>>
ElementOrder<S>natural()
Returns an instance which specifies that the natural ordering of the elements is guaranteed.static <S> ElementOrder<S>
sorted(Comparator<S> comparator)
Returns an instance which specifies that the ordering of the elements is guaranteed to be determined bycomparator
.static <S> ElementOrder<S>
stable()
Returns an instance which specifies that ordering is guaranteed to be always be the same across iterations, and across releases.String
toString()
Returns a string representation of the object.ElementOrder.Type
type()
Returns the type of ordering used.static <S> ElementOrder<S>
unordered()
Returns an instance which specifies that no ordering is guaranteed.
-
-
-
Method Detail
-
unordered
public static <S> ElementOrder<S> unordered()
Returns an instance which specifies that no ordering is guaranteed.
-
stable
public static <S> ElementOrder<S> stable()
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
andValueGraph
:edges()
: Stable orderadjacentNodes(node)
: Connecting edge insertion orderpredecessors(node)
: Connecting edge insertion ordersuccessors(node)
: Connecting edge insertion orderincidentEdges(node)
: Edge insertion order
- For
Network
:adjacentNodes(node)
: Stable orderpredecessors(node)
: Connecting edge insertion ordersuccessors(node)
: Connecting edge insertion orderincidentEdges(node)
: Stable orderinEdges(node)
: Edge insertion orderoutEdges(node)
: Edge insertion orderadjacentEdges(edge)
: Stable orderedgesConnecting(nodeU, nodeV)
: Edge insertion order
- Since:
- 29.0
- For
-
insertion
public static <S> ElementOrder<S> insertion()
Returns an instance which specifies that insertion ordering is guaranteed.
-
natural
public static <S extends Comparable<? super S>> ElementOrder<S> natural()
Returns an instance which specifies that the natural ordering of the elements is guaranteed.
-
sorted
public static <S> ElementOrder<S> sorted(Comparator<S> comparator)
Returns an instance which specifies that the ordering of the elements is guaranteed to be determined bycomparator
.
-
type
public ElementOrder.Type type()
Returns the type of ordering used.
-
comparator
public Comparator<T> comparator()
Returns theComparator
used.- Throws:
UnsupportedOperationException
- if comparator is not defined
-
equals
public boolean equals(@CheckForNull Object obj)
Description copied from class:java.lang.Object
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 returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
The
equals
method for classObject
implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference valuesx
andy
, this method returnstrue
if and only ifx
andy
refer to the same object (x == y
has the valuetrue
).Note that it is generally necessary to override the
hashCode
method whenever this method is overridden, so as to maintain the general contract for thehashCode
method, which states that equal objects must have equal hash codes.- Overrides:
equals
in classObject
- Parameters:
obj
- the reference object with which to compare.- Returns:
true
if this object is the same as the obj argument;false
otherwise.- See Also:
Object.hashCode()
,HashMap
- It is reflexive: for any non-null reference value
-
hashCode
public int hashCode()
Description copied from class:java.lang.Object
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided byHashMap
.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 inequals
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(Object)
method, then calling thehashCode
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
Object.equals(java.lang.Object)
method, then calling thehashCode
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.
As much as is reasonably practical, the hashCode method defined by class
Object
does return distinct integers for distinct objects. (The hashCode may or may not be implemented as some function of an object's memory address at some point in time.)- Overrides:
hashCode
in classObject
- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
- Whenever it is invoked on the same object more than once during
an execution of a Java application, the
-
toString
public String toString()
Description copied from class:java.lang.Object
Returns a string representation of the object. In general, thetoString
method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.The
toString
method for classObject
returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@
', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:getClass().getName() + '@' + Integer.toHexString(hashCode())
-
-