cz.ues.platform.commons.lang

Class UESResultList<E,C extends UESPagingCriteria>

java.lang.Object

cz.ues.platform.commons.lang.UESResultList<E,C>

Type Parameters:

E - The type of elements stored in Result.

All Implemented Interfaces:

java.lang.Iterable<E>

@XMLBindable
public class UESResultList<E,C extends UESPagingCriteria>
extends java.lang.Object
implements java.lang.Iterable<E>

This data-structure should be used for paging large result-set. It is typically used as return value for UESCommand services. As parameter for the service should be used the corresponding DTO structure implementing the UESPagingCriteria interface.

Since:

UES6-00

See Also:

UESPagingCriteria

Field Summary

Fields

Modifier and Type	Field and Description
private C	criteria
private java.util.List<E>	pageEntries
private static long	serialVersionUID
private int	totalSize

Constructor Summary

Constructors

Constructor and Description
UESResultList() Creates a new instance of UESResultList.
UESResultList(C criteria, int totalSize)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e) Appends the specified element to the end of this list (optional operation).
void	add(int index, E element) Inserts the specified element at the specified position in this list (optional operation).
boolean	addAll(java.util.Collection<? extends E> c) Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation).
boolean	addAll(int index, java.util.Collection<? extends E> c) Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
void	clear() Removes all of the elements from this list (optional operation).
boolean	contains(java.lang.Object o) Returns true if this list contains the specified element.
boolean	containsAll(java.util.Collection<?> c) Returns true if this list contains all of the elements of the specified collection.
boolean	equals(java.lang.Object o) Compares the specified object with this list for equality.
E	get(int index) Returns the element at the specified position in this list.
C	getCriteria() Returns criteria used to obtain this UESResultList.
int	getMaxResultSize() Returns maximum count of objects to be returned as result of the operation.
int	getResultIndex() Returns index of the current page to be returned as result of the operation.
int	getTotalSize() Returns total count of objects matching the specified criteria.
int	hashCode() Returns the hash code value for this list.
int	indexOf(java.lang.Object o) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
boolean	isEmpty() Returns true if this list contains no elements.
java.util.Iterator<E>	iterator() Returns an iterator over the elements in this list in proper sequence.
int	lastIndexOf(java.lang.Object o) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
java.util.ListIterator<E>	listIterator() Returns a list iterator over the elements in this list (in proper sequence).
java.util.ListIterator<E>	listIterator(int index) Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
E	remove(int index) Removes the element at the specified position in this list (optional operation).
boolean	remove(java.lang.Object o) Removes the first occurrence of the specified element from this list, if it is present (optional operation).
boolean	removeAll(java.util.Collection<?> c) Removes from this list all of its elements that are contained in the specified collection (optional operation).
boolean	retainAll(java.util.Collection<?> c) Retains only the elements in this list that are contained in the specified collection (optional operation).
E	set(int index, E element) Replaces the element at the specified position in this list with the specified element (optional operation).
void	setCriteria(C crit) Sets criteria used to obtain this UESResultList.
private void	setTotalSize(int totalSize) Sets total count of objects matching the specified criteria.
int	size() Returns the number of elements in this list.
java.util.List<E>	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
java.lang.Object[]	toArray() Returns an array containing all of the elements in this list in proper sequence (from first to last element).
<T> T[]	toArray(T[] a) Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final serialVersionUID

See Also:

Constant Field Values

criteria

private criteria

totalSize

private totalSize

pageEntries

private final pageEntries

Constructor Detail

UESResultList

public UESResultList()

Creates a new instance of UESResultList.

This constructor should not be used directly. It is provided for compatibility with JAXB. Please use the {@link #UESResultList(PaginationCriteria, List, int) instead.

Since:

UES6-00

UESResultList

public UESResultList(C criteria,
int totalSize)

Method Detail

add

public boolean add(E e)

Appends the specified element to the end of this list (optional operation).

Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.

Parameters:

e - element to be appended to this list

Returns:

true (as specified by Collection.add(E))

Throws:

java.lang.UnsupportedOperationException - if the add operation is not supported by this list

java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list

java.lang.NullPointerException - if the specified element is null and this list does not permit null elements

java.lang.IllegalArgumentException - if some property of this element prevents it from being added to this list

Since:

UES6-00

See Also:

List.add(java.lang.Object)

add

public void add(int index,
E element)

Inserts the specified element at the specified position in this list (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Parameters:

index - index at which the specified element is to be inserted

element - element to be inserted

Throws:

java.lang.UnsupportedOperationException - if the add operation is not supported by this list

java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list

java.lang.NullPointerException - if the specified element is null and this list does not permit null elements

java.lang.IllegalArgumentException - if some property of the specified element prevents it from being added to this list

java.lang.IndexOutOfBoundsException - if the index is out of range ( index < 0 || index > size())

Since:

UES6-00

See Also:

List.add(int, java.lang.Object)

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's iterator (optional operation). The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Parameters:

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the addAll operation is not supported by this list

java.lang.ClassCastException - if the class of an element of the specified collection prevents it from being added to this list

java.lang.NullPointerException - if the specified collection contains one or more null elements and this list does not permit null elements, or if the specified collection is null

java.lang.IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this list

Since:

UES6-00

See Also:

List.addAll(java.util.Collection)

addAll

public boolean addAll(int index,
java.util.Collection<? extends E> c)

Inserts all of the elements in the specified collection into this list at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Parameters:

index - index at which to insert the first element from the specified collection

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the addAll operation is not supported by this list

java.lang.ClassCastException - if the class of an element of the specified collection prevents it from being added to this list

java.lang.NullPointerException - if the specified collection contains one or more null elements and this list does not permit null elements, or if the specified collection is null

java.lang.IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this list

java.lang.IndexOutOfBoundsException - if the index is out of range ( index < 0 || index > size())

Since:

UES6-00

See Also:

List.addAll(int, java.util.Collection)

clear

public void clear()

Removes all of the elements from this list (optional operation). The list will be empty after this call returns.

Throws:

java.lang.UnsupportedOperationException - if the clear operation is not supported by this list

Since:

UES6-00

See Also:

List.clear()

contains

public boolean contains(java.lang.Object o)

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).

Parameters:

o - element whose presence in this list is to be tested

Returns:

true if this list contains the specified element

Throws:

java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional)

java.lang.NullPointerException - if the specified element is null and this list does not permit null elements (optional)

Since:

UES6-00

See Also:

List.contains(java.lang.Object)

containsAll

public boolean containsAll(java.util.Collection<?> c)

Returns true if this list contains all of the elements of the specified collection.

Parameters:

c - collection to be checked for containment in this list

Returns:

true if this list contains all of the elements of the specified collection

Throws:

java.lang.ClassCastException - if the types of one or more elements in the specified collection are incompatible with this list (optional)

java.lang.NullPointerException - if the specified collection contains one or more null elements and this list does not permit null elements (optional), or if the specified collection is null

Since:

UES6-00

See Also:

List.containsAll(java.util.Collection)

equals

public boolean equals(java.lang.Object o)

Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal. (Two elements e1 and e2 are equal if (e1==null ? e2==null : e1.equals(e2)).) In other words, two lists are defined to be equal if they contain the same elements in the same order. This definition ensures that the equals method works properly across different implementations of the List interface.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to be compared for equality with this list

Returns:

true if the specified object is equal to this list

Since:

UES6-00

See Also:

List.equals(java.lang.Object)

get

public E get(int index)

Returns the element at the specified position in this list.

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this list

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range ( index < 0 || index >= size())

Since:

UES6-00

See Also:

List.get(int)

hashCode

public int hashCode()

Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation:

 int hashCode = 1;
 Iterator<E> i = list.iterator();
 while (i.hasNext()) {
   E obj = i.next();
   hashCode = 31 * hashCode + (obj == null ? 0 : obj.hashCode());
 }
 

This ensures that list1.equals(list2) implies that list1.hashCode()==list2.hashCode() for any two lists, list1 and list2, as required by the general contract of Object.hashCode().

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code value for this list

Since:

UES6-00

See Also:

Object.equals(Object), UESResultList.equals(Object), List.hashCode()

indexOf

public int indexOf(java.lang.Object o)

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Parameters:

o - element to search for

Returns:

the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element

Throws:

java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional)

java.lang.NullPointerException - if the specified element is null and this list does not permit null elements (optional)

Since:

UES6-00

See Also:

List.indexOf(java.lang.Object)

isEmpty

public boolean isEmpty()

Returns true if this list contains no elements.

Returns:

true if this list contains no elements

Since:

UES6-00

See Also:

List.isEmpty()

iterator

public java.util.Iterator<E> iterator()

Returns an iterator over the elements in this list in proper sequence.

Specified by:

iterator in interface java.lang.Iterable<E>

Returns:

an iterator over the elements in this list in proper sequence

Since:

UES6-00

See Also:

List.iterator()

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Parameters:

o - element to search for

Returns:

the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

Throws:

java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional)

java.lang.NullPointerException - if the specified element is null and this list does not permit null elements (optional)

Since:

UES6-00

See Also:

List.lastIndexOf(java.lang.Object)

listIterator

public java.util.ListIterator<E> listIterator()

Returns a list iterator over the elements in this list (in proper sequence).

Returns:

a list iterator over the elements in this list (in proper sequence)

Since:

UES6-00

See Also:

List.listIterator()

listIterator

public java.util.ListIterator<E> listIterator(int index)

Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. The specified index indicates the first element that would be returned by an initial call to next. An initial call to previous would return the element with the specified index minus one.

Parameters:

index - index of first element to be returned from the list iterator (by a call to the next method)

Returns:

a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range ( index < 0 || index > size())

Since:

UES6-00

See Also:

List.listIterator(int)

remove

public E remove(int index)

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

Throws:

java.lang.UnsupportedOperationException - if the remove operation is not supported by this list

java.lang.IndexOutOfBoundsException - if the index is out of range ( index < 0 || index >= size())

Since:

UES6-00

See Also:

List.remove(int)

remove

public boolean remove(java.lang.Object o)

Removes the first occurrence of the specified element from this list, if it is present (optional operation). If this list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Parameters:

o - element to be removed from this list, if present

Returns:

true if this list contained the specified element

Throws:

java.lang.ClassCastException - if the type of the specified element is incompatible with this list (optional)

java.lang.NullPointerException - if the specified element is null and this list does not permit null elements (optional)

java.lang.UnsupportedOperationException - if the remove operation is not supported by this list

Since:

UES6-00

See Also:

List.remove(java.lang.Object)

removeAll

public boolean removeAll(java.util.Collection<?> c)

Removes from this list all of its elements that are contained in the specified collection (optional operation).

Parameters:

c - collection containing elements to be removed from this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the removeAll operation is not supported by this list

java.lang.ClassCastException - if the class of an element of this list is incompatible with the specified collection (optional)

java.lang.NullPointerException - if this list contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null

Since:

UES6-00

See Also:

List.removeAll(java.util.Collection)

retainAll

public boolean retainAll(java.util.Collection<?> c)

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all the elements that are not contained in the specified collection.

Parameters:

c - collection containing elements to be retained in this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.UnsupportedOperationException - if the retainAll operation is not supported by this list

java.lang.ClassCastException - if the class of an element of this list is incompatible with the specified collection (optional)

java.lang.NullPointerException - if this list contains a null element and the specified collection does not permit null elements (optional), or if the specified collection is null

Since:

UES6-00

See Also:

List.retainAll(java.util.Collection)

set

public E set(int index,
E element)

Replaces the element at the specified position in this list with the specified element (optional operation).

Parameters:

index - index of the element to replace

element - element to be stored at the specified position

Returns:

the element previously at the specified position

Throws:

java.lang.UnsupportedOperationException - if the set operation is not supported by this list

java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list

java.lang.NullPointerException - if the specified element is null and this list does not permit null elements

java.lang.IllegalArgumentException - if some property of the specified element prevents it from being added to this list

java.lang.IndexOutOfBoundsException - if the index is out of range ( index < 0 || index >= size())

Since:

UES6-00

See Also:

List.set(int, java.lang.Object)

size

public int size()

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Returns:

the number of elements in this list

Since:

UES6-00

See Also:

List.size()

subList

public java.util.List<E> subList(int fromIndex,
int toIndex)

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so non-structural changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

 list.subList(from, to).clear();
 

Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

The semantics of the list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Parameters:

fromIndex - low endpoint (inclusive) of the subList

toIndex - high endpoint (exclusive) of the subList

Returns:

a view of the specified range within this list

Throws:

java.lang.IndexOutOfBoundsException - for an illegal endpoint index value ( fromIndex < 0 || toIndex > size || fromIndex > toIndex)

Since:

UES6-00

See Also:

List.subList(int, int)

toArray

public java.lang.Object[] toArray()

Returns an array containing all of the elements in this list in proper sequence (from first to last element).

The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array even if this list is backed by an array). The caller is thus free to modify the returned array.

This method acts as bridge between array-based and collection-based APIs.

Returns:

an array containing all of the elements in this list in proper sequence

Since:

UES6-00

See Also:

List.toArray()

toArray

public <T> T[] toArray(T[] a)

Returns an array containing all of the elements in this list in proper sequence (from first to last element); the runtime type of the returned array is that of the specified array. If the list fits in the specified array, it is returned therein. Otherwise, a new array is allocated with the runtime type of the specified array and the size of this list.

If the list fits in the specified array with room to spare (i.e., the array has more elements than the list), the element in the array immediately following the end of the list is set to null. (This is useful in determining the length of the list only if the caller knows that the list does not contain any null elements.)

Like the UESResultList.toArray() method, this method acts as bridge between array-based and collection-based APIs. Further, this method allows precise control over the runtime type of the output array, and may, under certain circumstances, be used to save allocation costs.

Suppose x is a list known to contain only strings. The following code can be used to dump the list into a newly allocated array of String:

 String[] y = x.toArray(new String[0]);
 

Note that toArray(new Object[0]) is identical in function to toArray().

Parameters:

a - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this list

Throws:

java.lang.ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this list

java.lang.NullPointerException - if the specified array is null

Since:

UES6-00

See Also:

java.util.List#toArray(T[])

setCriteria

public void setCriteria(C crit)

Sets criteria used to obtain this UESResultList.

Parameters:

crit - the criteria.

Since:

UES6-00

setTotalSize

private void setTotalSize(int totalSize)

Sets total count of objects matching the specified criteria.

Parameters:

totalSize - the total objects count.

Since:

UES6-00

getResultIndex

public int getResultIndex()

Returns index of the current page to be returned as result of the operation. The value is always >=0.

Returns:

the current page index.

Since:

UES6-00

getMaxResultSize

public int getMaxResultSize()

Returns maximum count of objects to be returned as result of the operation. The value is always >=1.

Returns:

maximum result size.

Since:

UES6-00

getTotalSize

public int getTotalSize()

Returns total count of objects matching the specified criteria.

Returns:

the total objects count.

Since:

UES6-00

getCriteria

public C getCriteria()

Returns criteria used to obtain this UESResultList.

Returns:

the criteria used.

Since:

UES6-00