Class ScanTerm

java.lang.Object
com.couchbase.client.java.kv.ScanTerm

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

    • id

      public String id()
      Returns 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.
    • 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.
    • toCore

      @Internal public CoreScanTerm toCore()
    • toString

      public String toString()
      Overrides:
      toString in class Object