@Beta @Immutable public final class ElementOrder<T> extends Object
Example usage:
MutableGraph<Integer> graph =
GraphBuilder.directed().nodeOrder(ElementOrder.<Integer>natural()).build();
Modifier and Type | Class and Description |
---|---|
static class |
ElementOrder.Type
The type of ordering that this object specifies.
|
Modifier and Type | Method and Description |
---|---|
Comparator<T> |
comparator()
Returns the
Comparator used. |
boolean |
equals(@Nullable 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>> |
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 by
comparator . |
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.
|
public static <S> ElementOrder<S> unordered()
public static <S> ElementOrder<S> insertion()
public static <S extends Comparable<? super S>> ElementOrder<S> natural()
public static <S> ElementOrder<S> sorted(Comparator<S> comparator)
comparator
.public ElementOrder.Type type()
public Comparator<T> comparator()
Comparator
used.UnsupportedOperationException
- if comparator is not definedpublic boolean equals(@Nullable Object obj)
java.lang.Object
The equals
method implements an equivalence relation
on non-null object references:
x
, x.equals(x)
should return
true
.
x
and y
, x.equals(y)
should return true
if and only if
y.equals(x)
returns true
.
x
, y
, and z
, if
x.equals(y)
returns true
and
y.equals(z)
returns true
, then
x.equals(z)
should return true
.
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.
x
,
x.equals(null)
should return false
.
The equals
method for class Object
implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x
and
y
, this method returns true
if and only
if x
and y
refer to the same object
(x == y
has the value true
).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode
method, which states
that equal objects must have equal hash codes.
equals
in class Object
obj
- the reference object with which to compare.true
if this object is the same as the obj
argument; false
otherwise.Object.hashCode()
,
HashMap
public int hashCode()
java.lang.Object
HashMap
.
The general contract of hashCode
is:
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.
equals(Object)
method, then calling the hashCode
method on each of
the two objects must produce the same integer result.
Object.equals(java.lang.Object)
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.
As much as is reasonably practical, the hashCode method defined by
class Object
does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
public String toString()
java.lang.Object
toString
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 class Object
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())
Copyright © 2010–2019. All rights reserved.