Package org.apache.cayenne.util
Class GenericResponse
java.lang.Object
org.apache.cayenne.util.GenericResponse
- All Implemented Interfaces:
Serializable,QueryResponse
A simple serializable implementation of QueryResponse.
- Since:
- 1.2
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionCreates an empty BaseResponse.GenericResponse(List<?> list) Creates a BaseResponse with a single result list.GenericResponse(QueryResponse response) Creates a response that it a shallow copy of another response. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBatchUpdateCount(int[] resultCount) voidaddResultIterator(ResultIterator<?> iterator) voidaddResultList(List<?> list) voidaddUpdateCount(int resultCount) voidclear()Clears any previously collected information.Returns a current iterator.List<?>Returns a List under the current iterator position.int[]Returns an update count under the current iterator position.A utility method for quickly retrieving the Iterator in the response.List<?>A utility method for quickly retrieving the first list in the response.int[]A utility method for quickly retrieving the first update count from the response.booleanReturns whether current response is an iteratorbooleanisList()Returns whether current iteration result is a list or an update count.booleannext()Rewinds response iterator to the next result, returning true if it is available.voidreplaceResult(Object oldResult, Object newResult) Replaces previously stored result with a new result.voidreset()Restarts response iterator.intsize()Returns a number of results in the response.
-
Field Details
-
results
-
currentIndex
protected transient int currentIndex
-
-
Constructor Details
-
GenericResponse
public GenericResponse()Creates an empty BaseResponse. -
GenericResponse
Creates a BaseResponse with a single result list. -
GenericResponse
Creates a response that it a shallow copy of another response.
-
-
Method Details
-
firstList
Description copied from interface:QueryResponseA utility method for quickly retrieving the first list in the response. Returns null if the query has no lists. Note that this method resets current iterator to an undefined state.- Specified by:
firstListin interfaceQueryResponse
-
firstIterator
Description copied from interface:QueryResponseA utility method for quickly retrieving the Iterator in the response. Returns null if the query has no iterator.- Specified by:
firstIteratorin interfaceQueryResponse
-
firstUpdateCount
public int[] firstUpdateCount()Description copied from interface:QueryResponseA utility method for quickly retrieving the first update count from the response. Note that this method resets current iterator to an undefined state.- Specified by:
firstUpdateCountin interfaceQueryResponse
-
currentList
Description copied from interface:QueryResponseReturns a List under the current iterator position. UseQueryResponse.isList()to check the result type before calling this method.- Specified by:
currentListin interfaceQueryResponse
-
currentIterator
Description copied from interface:QueryResponseReturns a current iterator.- Specified by:
currentIteratorin interfaceQueryResponse
-
currentUpdateCount
public int[] currentUpdateCount()Description copied from interface:QueryResponseReturns an update count under the current iterator position. Returned value is an int[] to accommodate batch queries. For a regular update result, the value will be an int[1]. UseQueryResponse.isList()to check the result type before calling this method.- Specified by:
currentUpdateCountin interfaceQueryResponse
-
isList
public boolean isList()Description copied from interface:QueryResponseReturns whether current iteration result is a list or an update count.- Specified by:
isListin interfaceQueryResponse
-
isIterator
public boolean isIterator()Description copied from interface:QueryResponseReturns whether current response is an iterator- Specified by:
isIteratorin interfaceQueryResponse
-
next
public boolean next()Description copied from interface:QueryResponseRewinds response iterator to the next result, returning true if it is available.- Specified by:
nextin interfaceQueryResponse
-
reset
public void reset()Description copied from interface:QueryResponseRestarts response iterator.- Specified by:
resetin interfaceQueryResponse
-
size
public int size()Description copied from interface:QueryResponseReturns a number of results in the response.- Specified by:
sizein interfaceQueryResponse
-
clear
public void clear()Clears any previously collected information. -
addBatchUpdateCount
public void addBatchUpdateCount(int[] resultCount) -
addUpdateCount
public void addUpdateCount(int resultCount) -
addResultList
-
addResultIterator
- Parameters:
iterator- to add as a result- Since:
- 5.0
-
replaceResult
Replaces previously stored result with a new result.
-