FilterAdapterContext (Cloud Bigtable HBase Client for Java 1.12.0 API)

com.google.cloud.bigtable.hbase.adapters.filters

Class FilterAdapterContext

• java.lang.Object
• • com.google.cloud.bigtable.hbase.adapters.filters.FilterAdapterContext

• ---

  
  

  @NotThreadSafe
  public class FilterAdapterContext
  extends Object

  Context for the currently executing filter adapter.

  Version:

  $Id: $Id

  Author:

  sduskis

• • Nested Class Summary

    Nested Classes 

    Modifier and Type	Class and Description
    static interface	FilterAdapterContext.ContextCloseable

  • Constructor Summary

    Constructors 

    Constructor and Description
    FilterAdapterContext(Scan scan, ReadHooks readHooks) Constructor for FilterAdapterContext.

  • Method Summary

    All Methods Instance Methods Concrete Methods 

    Modifier and Type	Method and Description
    void	addWhileMatchFilter(WhileMatchFilter filter) addWhileMatchFilter.
    FilterAdapterContext.ContextCloseable	beginFilterList(FilterList lst) beginFilterList.
    Optional<FilterList>	getCurrentFilterList() getCurrentFilterList.
    int	getFilterListDepth() getFilterListDepth.
    String	getNextUniqueId() Returns the next unique ID as a String in this adapter context.
    int	getNumberOfWhileMatchFilters() getNumberOfWhileMatchFilters.
    ReadHooks	getReadHooks() Getter for the field readHooks.

    • Methods inherited from class java.lang.Object

      clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• • Constructor Detail

    • FilterAdapterContext

      public FilterAdapterContext(Scan scan,
                                  ReadHooks readHooks)

      Constructor for FilterAdapterContext.

      Parameters:

      scan - a Scan object.

      readHooks - a ReadHooks object.

  • Method Detail

    • beginFilterList

      public FilterAdapterContext.ContextCloseable beginFilterList(FilterList lst)

      beginFilterList.

      Parameters:

      lst - a FilterList object.

      Returns:

      a FilterAdapterContext.ContextCloseable object.

    • getFilterListDepth

      public int getFilterListDepth()

      getFilterListDepth.

      Returns:

      a int.

    • getCurrentFilterList

      public Optional<FilterList> getCurrentFilterList()

      getCurrentFilterList.

      Returns:

      a Optional object.

    • getReadHooks

      public ReadHooks getReadHooks()

      Getter for the field readHooks.

      Returns:

      a ReadHooks object.

    • getNextUniqueId

      public String getNextUniqueId()

      Returns the next unique ID as a String in this adapter context.

      Returns:

      a String object.

    • addWhileMatchFilter

      public void addWhileMatchFilter(WhileMatchFilter filter)

      addWhileMatchFilter.

      Parameters:

      filter - a WhileMatchFilter object.

    • getNumberOfWhileMatchFilters

      public int getNumberOfWhileMatchFilters()

      getNumberOfWhileMatchFilters.

      Returns:

      a int.