CursorEnumeration (BlackBerry JDE 6.0.0 API Reference)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.rim.device.api.database
Class CursorEnumeration

java.lang.Object
  net.rim.device.api.database.CursorEnumeration

All Implemented Interfaces:: Enumeration

public class CursorEnumeration
extends Object
implements Enumeration
extends Object
implements Enumeration

Wraps cursor operations in the Enumeration interface.

When you have a Cursor or BufferedCursor, you can construct an associated CursorEnumeration that lets you move around the data in the cursor.

Hides all the database errors.

Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

Constructor Summary
	`CursorEnumeration(Cursor cursor)` Creates cursor enumeration based on the given cursor.

Method Summary
	`boolean`	`hasMoreElements()` Checks whether there are more rows in the cursor.
	`Object`	`nextElement()` Navigates to the next row and returns it.

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

CursorEnumeration

public CursorEnumeration(Cursor cursor)
                  throws NullPointerException

Creates cursor enumeration based on the given cursor.

Parameters:: cursor - Cursor with data.
Throws:: NullPointerException - If the cursor parameter is null.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

Method Detail

hasMoreElements

public boolean hasMoreElements()

Checks whether there are more rows in the cursor.

It is safe to call this method multiple times because it does not perform any cursor navigation.

Specified by:: hasMoreElements in interface Enumeration

Returns:: true if the cursor is not empty and there are more rows to fetch; false otherwise.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0

nextElement

public Object nextElement()
                   throws NoSuchElementException

Navigates to the next row and returns it.

Specified by:: nextElement in interface Enumeration

Returns:: a Row instance.
Throws:: NoSuchElementException - If there are no more rows in the cursor.
Category:: Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.
Since:: BlackBerry API 5.0.0