com.fatwire.assetapi.data.search

Class Orders

java.lang.Object

com.fatwire.assetapi.data.search.Orders

All Implemented Interfaces:

Iterable<Order>

@Exported
public class Orders
extends Object
implements Iterable<Order>

Represents the sequence for sorting the results returned by a search. Each item in the sequence is represented by an Order instance.

Constructor Summary

Constructors

Constructor and Description
Orders() Default constructor instantiates the container guaranteed on insert-order.
Orders(Orders source) Copy constructor builds a new instance from the source.

Method Summary

Modifier and Type	Method and Description
boolean	add(Order e) Adds the specified order at the end of this sequence.
boolean	addAll(Orders e) Adds the specified sequence of orders at the end of this sequence.
void	clear() Removes all orders from this sequence.
boolean	contains(Order o) Returns true if the specified Order is already included in the sequence.
boolean	equals(Object obj) Compares the specified object with this sequence of orders for equality.
int	hashCode() Returns the hash code value for this sequence of orders.
boolean	isEmpty() Returns true if there are no items in the sorting sequence.
Iterator<Order>	iterator()
boolean	remove(Order o) Removes the specified order from this sequence.
boolean	removeAll(Orders c) Removes the orders from the specified sequence from this sequence.
boolean	retainAll(Orders c) Retains only the orders from the specified sequence in this sequence, removes the rest of the orders from this sequence.
Order[]	toArray(Order[] a) Returns an array representation of this sequence.
String	toString() Returns a string representation of this order.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Orders

public Orders()

Default constructor instantiates the container guaranteed on insert-order.

Orders

public Orders(Orders source)

Copy constructor builds a new instance from the source.

Parameters:

source - the source instance from which the state is replicated in the new instance.

Method Detail

isEmpty

public boolean isEmpty()

Returns true if there are no items in the sorting sequence.

Returns:

true if there are no items in the sorting sequence, false otherwise.

contains

public boolean contains(Order o)

Returns true if the specified Order is already included in the sequence.

Parameters:

o - the order to search for.

Returns:

true if the specified Order is already included in the sequence, false otherwise.

toArray

public Order[] toArray(Order[] a)

Returns an array representation of this sequence.

Parameters:

a - the array to populate with the array view of this sequence.

Returns:

an array representation of this sequence.

add

public boolean add(Order e)

Adds the specified order at the end of this sequence.

Parameters:

e - the order to add.

Returns:

true if this sequence changed as a result of the call, false otherwise.

addAll

public boolean addAll(Orders e)

Adds the specified sequence of orders at the end of this sequence.

Parameters:

e - the sequence of orders to add.

Returns:

true if this sequence changed as a result of the call, false otherwise.

remove

public boolean remove(Order o)

Removes the specified order from this sequence.

Parameters:

o - the order to remove

Returns:

true if this sequence changed as a result of the call, false otherwise.

removeAll

public boolean removeAll(Orders c)

Removes the orders from the specified sequence from this sequence.

Parameters:

c - the sequence of orders to remove.

Returns:

true if this sequence changed as a result of the call, false otherwise.

retainAll

public boolean retainAll(Orders c)

Retains only the orders from the specified sequence in this sequence, removes the rest of the orders from this sequence.

Parameters:

c - the sequence of orders to retain.

Returns:

true if this sequence changed as a result of the call, false otherwise.

clear

public void clear()

Removes all orders from this sequence.

iterator

public Iterator<Order> iterator()

Specified by:

iterator in interface Iterable<Order>

toString

public String toString()

Returns a string representation of this order.

The string representation is: ORDER BY first order THEN BY more orders....

Overrides:

toString in class Object

Returns:

a string representation of this order.

See Also:

Object.toString()

hashCode

public int hashCode()

Returns the hash code value for this sequence of orders.

The hash code of a sequence of orders is defined to be the sum of the hash codes of its elements. This ensures that o1.equals(o2) implies that o1.hashCode() == o2.hashCode() for any two sequence of orders o1 and o2, as required by the general contract of Object.hashCode().

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Compares the specified object with this sequence of orders for equality.

Returns true if the given object is also a sequence of orders and the two orders represent the same sequence of orders. Two sequences of orders o1 and o2 represent the same sequence of orders if they have the same sizes and, if for each corresponding element o1 and o2, o1.equals(o2) returns true.

This implementation first checks if the specified object is this sequence of orders; if so it returns true. Then, it checks if the specified sequence of orders have the same size as this, and their corresponding elements are equal as described above.

Overrides:

equals in class Object

Parameters:

obj - object to be compared for equality with this order

Returns:

true if the specified object is equal to this order

See Also:

Object.equals(java.lang.Object)