@Exported public class Order extends Object
The order will specify the field according to which the results will be sorted. It will also specify the direction of sorting i.e., whether the sorting will be in ascending or descending order.
An Order
instance overrides Order.hashCode()
and Order.equals(Object)
and hence can be used in sets.
Constructor and Description |
---|
Order()
Default constructor - does not instantiate any fields.
|
Order(Order source)
Copy constructor builds a new instance from the source.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Compares the specified object with this order for equality.
|
SortDirection |
getDirection()
Returns the direction for this order.
|
String |
getField()
Returns the field for this order.
|
int |
hashCode()
Returns the hash code value for this order.
|
void |
setDirection(SortDirection direction)
Sets the direction for this order.
|
void |
setField(String field)
Sets the field for this order.
|
String |
toString()
Returns a string representation of this order.
|
public Order()
public Order(Order source)
source
- the source instance from which the state is replicated in the new instance.public String getField()
public void setField(String field)
field
- the field to setpublic SortDirection getDirection()
SortDirection
public void setDirection(SortDirection direction)
direction
- the direction to setSortDirection
public String toString()
The string representation is: field direction
, for example: name DESC
.
toString
in class Object
Object.toString()
public int hashCode()
The hash code of an order is defined to be the sum of the hash codes of its field and its direction.
This ensures that o1.equals(o2)
implies that o1.hashCode() == o2.hashCode()
for any two orders o1
and o2
, as required by the general contract of Object.hashCode()
.
hashCode
in class Object
Object.hashCode()
public boolean equals(Object obj)
Returns true
if the given object is also an order and the two orders represent the same order.
Two orders o1
and o2
represent the same order if o1.getField().equals(o2.getField())
, o1.getDirection().equals(o2.getDirection())
are true
.
This implementation first checks if the specified object is this order; if so it returns true
.
Then, it checks if the specified object is an order whose field and direction are also equal.
equals
in class Object
obj
- object to be compared for equality with this ordertrue
if the specified object is equal to this orderObject.equals(java.lang.Object)