Package com.couchbase.client.java.kv

Class ScanTerm

  • @Volatile
public class ScanTerm
extends Object
    A single ScanTerm identifying either the point to scan from or to scan to.

    • Method Detail

      • id

        public byte[] id()
        Returns a new byte array containing the key pattern of this term.

      • exclusive

        public boolean exclusive()

      • inclusive

        public static ScanTerm inclusive​(String id)
        Creates an inclusive ScanTerm from a UTF-8 string.
        Parameters:
        id - the document ID / pattern to use as the scan term.
        Returns:
        the created ScanTerm.

      • inclusive

        public static ScanTerm inclusive​(byte[] id)
        Creates an inclusive ScanTerm from a byte array.
        Parameters:
        id - the document ID / pattern to use as the scan term.
        Returns:
        the created ScanTerm.

      • exclusive

        public static ScanTerm exclusive​(String id)
        Creates an exclusive ScanTerm from a UTF-8 string.
        Parameters:
        id - the document ID / pattern to use as the scan term.
        Returns:
        the created ScanTerm.

      • exclusive

        public static ScanTerm exclusive​(byte[] id)
        Creates an exclusive ScanTerm from a byte array.
        Parameters:
        id - the document ID / pattern to use as the scan term.
        Returns:
        the created ScanTerm.

      • minimum

        public static ScanTerm minimum()
        Returns a scan term representing the absolute minimum pattern (starting point).

        Equivalent to ScanTerm.inclusive(new byte[]{(byte) 0x00})

        Returns:
        the absolute minimum ScanTerm.

      • maximum

        public static ScanTerm maximum()
        Returns a scan term representing the absolute maximum pattern (end point).

        Equivalent to ScanTerm.inclusive(new byte[]{(byte) 0xFF})

        Returns:
        the absolute maximum ScanTerm.