recordenumeration.java

J2me唆哈的代码

/*
 * Created on 2004-12-24 by Tianlei
 * version 1.0.0.3
 * since MIDP1.0
 * 如果有不明白的,详细信息参见MIDP2.0的源码
 */
package javax.microedition.rms;

/**
 * @author Tianlei
 * @version 1.0.0.3
 * @since MIDP1.0
 * 如果有不明白的,详细信息参见MIDP2.0的源码
 */
public interface RecordEnumeration {
    /**
     * 得到记录的个数
     * @return 记录的个数
     * @since MIDP1.0
     */
    public int numRecords();

    /**
     * 得到下一个记录
     * @return 下一个记录的一份拷贝
     * @throws InvalidRecordIDException 如果已经没有有效记录了,抛出这个异常
     * @throws RecordStoreNotOpenException 如果数据库没有打开,抛出这个异常
     * @throws RecordStoreException 如果通常的数据库异常发生,抛出这个异常
     * @since MIDP1.0
     */
    public byte[] nextRecord() throws InvalidRecordIDException,
            RecordStoreNotOpenException, RecordStoreException;
    /**
     * 该数据库中下一个记录的标号
     * @return 下一个记录的标号
     * @throws InvalidRecordIDException 如果已经没有有效的记录了,抛出这个异常
     * @since MIDP1.0
     */
    public int nextRecordId() throws InvalidRecordIDException;
    /**
     * 数据库中前一个记录
     * @return 前一个记录
     * @throws InvalidRecordIDException 如果已经没有有效的记录了,抛出这个异常
     * @throws RecordStoreNotOpenException 如果数据库没有打开,抛出这个异常
     * @throws RecordStoreException 如果是普通的数据库异常,抛出这个异常
     * @since MIDP1.0
     */
    public byte[] previousRecord() throws InvalidRecordIDException,
            RecordStoreNotOpenException, RecordStoreException;
    /**
     * 数据库中前一个记录的标号
     * @return 前一个记录的标号
     * @throws InvalidRecordIDException 如果已经没有有效的记录了,抛出这个异常
     * @since MIDP1.0
     */
    public int previousRecordId() throws InvalidRecordIDException;

    /**
     * 如果在"下一个"的方向上,还有有效的记录,返回true
     * @return 如果在"下一个"的方向上,还有有效的记录,返回true
     * @since MIDP1.0
     */
    public boolean hasNextElement();
    /**
     * 如果在"前一个"的方向上,还有有效的记录,返回true
     * @return 如果在"前一个"的方向上,还有有效的记录,返回true
     * @since MIDP1.0
     */
    public boolean hasPreviousElement();
    /**
     * 将枚举index重新设置成这个数据库枚举刚创建出来时的位置
     * @since MIDP1.0
     */
    public void reset();
    /**
     * 要求数据库枚举更新信息,从而包括进该数据库最新的改动
     * @since MIDP1.0
     */
    public void rebuild();

    /**
     * 设置数据库枚举是否使内部的index和数据库的增加,修改,删除保持一致
     * @param keepUpdated 如果为true,则数据库的记录增加,修改,删除都会影响枚举的index
     * @since MIDP1.0
     */
    public void keepUpdated(boolean keepUpdated);
    /**
     * 判断该枚举是否和数据库保持同步更新
     * @return 如果枚举和数据库保持同步更新,返回true,否则false
     * @since MIDP1.0
     */
    public boolean isKeptUpdated();
    /**
     * 销毁这个数据库枚举对象,释放资源
     * @since MIDP1.0
     */
    public void destroy();
}