com.atlassian.jira.ofbiz

Interface OfBizListIterator

All Superinterfaces:

AutoCloseable, Iterable<org.ofbiz.core.entity.GenericValue>

All Known Implementing Classes:

DefaultOfBizListIterator, MockOfBizListIterator

@PublicApi
public interface OfBizListIterator
extends Iterable<org.ofbiz.core.entity.GenericValue>, AutoCloseable

A wrapper around EntityListIterator that does not throw GenericEntityException.

Note: This does not follow the contract for Iterator, in that the next() call does not throw NoSuchElementException but returns a null value if the last element has been reached.

IMPORTANT: this iterator must be closed in a finally block, or connection leaks will ensue.

Method Summary

Modifier and Type	Method and Description
boolean	absolute(int i)
void	add(org.ofbiz.core.entity.GenericValue o)
void	afterLast()
void	beforeFirst()
void	close() Closes the iterator.
org.ofbiz.core.entity.GenericValue	currentGenericValue()
int	currentIndex()
boolean	first()
List<org.ofbiz.core.entity.GenericValue>	getCompleteList()
List<org.ofbiz.core.entity.GenericValue>	getPartialList(int i, int i1)
boolean	isCaseSensitive(String fieldName) Returns true if the specified field name in the database is case sensitive.
Iterator<org.ofbiz.core.entity.GenericValue>	iterator() Returns a read-only iterator over the result sets.
boolean	last()
org.ofbiz.core.entity.GenericValue	next()
int	nextIndex()
org.ofbiz.core.entity.GenericValue	previous()
int	previousIndex()
void	remove()
void	set(org.ofbiz.core.entity.GenericValue o)
void	setDelegator(org.ofbiz.core.entity.GenericDelegator genericDelegator)
void	setFetchSize(int i)

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

setDelegator

void setDelegator(org.ofbiz.core.entity.GenericDelegator genericDelegator)

afterLast

void afterLast()

beforeFirst

void beforeFirst()

last

boolean last()

first

boolean first()

close

void close()

Closes the iterator. Logs exceptions and does not propagate them.

Specified by:

close in interface AutoCloseable

currentGenericValue

org.ofbiz.core.entity.GenericValue currentGenericValue()

currentIndex

int currentIndex()

absolute

boolean absolute(int i)

next

org.ofbiz.core.entity.GenericValue next()

nextIndex

int nextIndex()

previous

org.ofbiz.core.entity.GenericValue previous()

previousIndex

int previousIndex()

setFetchSize

void setFetchSize(int i)

getCompleteList

List<org.ofbiz.core.entity.GenericValue> getCompleteList()

getPartialList

List<org.ofbiz.core.entity.GenericValue> getPartialList(int i,
                                                        int i1)

add

void add(org.ofbiz.core.entity.GenericValue o)

remove

void remove()

set

void set(org.ofbiz.core.entity.GenericValue o)

isCaseSensitive

boolean isCaseSensitive(String fieldName)

Returns true if the specified field name in the database is case sensitive.

Parameters:

fieldName - the name of the entity field

Returns:

true if the field is case sensitive in the database

Throws:

DataAccessException - if an underlying problem occurs.

iterator

Iterator<org.ofbiz.core.entity.GenericValue> iterator()

Returns a read-only iterator over the result sets.

Specified by:

iterator in interface Iterable<org.ofbiz.core.entity.GenericValue>

Returns:

an Iterator