com.yahoo.imapnio.async.data.PartialExtensionUidFetchInfo Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of imapnio.core Show documentation

imapnio component ${project.name}

The newest version!

package com.yahoo.imapnio.async.data;

/**
 * The PARTIAL extension of the Internet Message Access Protocol (RFC 3501/RFC 9051) allows clients
 * to limit the number of search results returned, as well as to perform incremental (paged) searches.
 * This also helps servers to optimize resource usage when performing searches.
 *
 *  * {@code
 * partial-range-first = nz-number ":" nz-number
 *        ;; Request to search from oldest (lowest UIDs) to
 *        ;; more recent messages.
 *        ;; A range 500:400 is the same as 400:500.
 *        ;; This is similar to  from [RFC3501],
 *        ;; but cannot contain "*".
 *
 * partial-range-last  = MINUS nz-number ":" MINUS nz-number
 *        ;; Request to search from newest (highest UIDs) to
 *        ;; oldest messages.
 *        ;; A range -500:-400 is the same as -400:-500.
 *
 * nz-number       = digit-nz *DIGIT
 *                   ; Non-zero unsigned 32-bit integer
 *                   ; (0 < n < 4,294,967,296)
 * }
 * 
 */

public class PartialExtensionUidFetchInfo {
    /** First uid number that needs to be searched. */
    private final int firstUid;

    /** Last uid number that needs to be searched. */
    private final int lastUid;

    /**
     * Instantiates a {@link PartialExtensionUidFetchInfo} with specific range including first and last uids.
     *
     * @param firstUid first uid to be searched
     * @param lastUid last uid to be searched
     */
    public PartialExtensionUidFetchInfo(final int firstUid, final int lastUid) {
        this.firstUid = firstUid;
        this.lastUid = lastUid;
    }

    /**
     * Returns first uid.
     *
     * @return first uid
     */
    public int getFirstUid() {
        return firstUid;
    }

    /**
     * Returns last uid.
     *
     * @return last uid
     */
    public int getLastUid() {
        return lastUid;
    }
}