Top Description Fields Constructors Methods
org.eclipse.persistence.internal.helper

public Class IndexedObject

extends Object
implements Comparable<IndexedObject>
Class Inheritance
All Implemented Interfaces
java.lang.Comparable
Imports
java.util.Collections, .Comparator, org.eclipse.persistence.internal.queries.OrderedListContainerPolicy

Purpose: A helper class for sorting index/object pairs.

Responsibilities: Allows to sort a list of index/object pairs either directly or with Collections.sort(List<IndexedObject>) - using IndexedObject.compareTo; or with Collections.sort(List<IndexedObject>, Comparator<IndexedObject>) - using custom-defined Comparator<IndexedObject>.

See Also
Collections, Comparator, OrderedListContainerPolicy

Field Summary

Modifier and TypeField and Description
private Integer
index

private Object
object

Constructor Summary

AccessConstructor and Description
public
IndexedObject(Integer index, Object object)

Method Summary

Modifier and TypeMethod and Description
public int
compareTo(IndexedObject
the object to be compared.
anotherIndexedObject)

Implements java.lang.Comparable.compareTo.

Compares this object with the specified object for order.
public Integer
getIndex()

public Object
getObject()

public void
setIndex(Integer index)

public void
setObject(Object object)

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

indexback to summary
private Integer index
objectback to summary
private Object object

Constructor Detail

IndexedObjectback to summary
public IndexedObject(Integer index, Object object)

Method Detail

compareToback to summary
public int compareTo(IndexedObject anotherIndexedObject)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

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

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

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

Parameters
anotherIndexedObject:IndexedObject

the object to be compared.

Returns:int

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations
@Override
getIndexback to summary
public Integer getIndex()
getObjectback to summary
public Object getObject()
setIndexback to summary
public void setIndex(Integer index)
setObjectback to summary
public void setObject(Object object)
toStringback to summary
public String toString()

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