Class TwitterPageableReader<E,C>

Method Details

• getPageSize

  public int getPageSize()

• getStartingOffset

  public long getStartingOffset()

  Returns the cursor of the first page requested (defaults to FIRST_PAGE).

• setStartingOffset

  public TwitterPageableReader<E,C> setStartingOffset(long startingOffset)

  Sets the cursor of the first page requested (defaults to FIRST_PAGE).

• getPage

  public long getPage()

  Returns the cursor of the next page to request.

• getDirection

  public TwitterPageableReader.Direction getDirection()

  Returns whether paging follows the next or the previous cursors (defaults to TwitterPageableReader.Direction.FORWARD).

• setDirection

  public TwitterPageableReader<E,C> setDirection(TwitterPageableReader.Direction direction)

  Sets whether paging follows the next or the previous cursors (defaults to TwitterPageableReader.Direction.FORWARD).

• setApiLimitPolicy

  public TwitterPageableReader<E,C> setApiLimitPolicy(IApiLimitPolicy apiLimitPolicy)

  Description copied from class: TwitterReader

  Sets the action taken when the API call limit is reached (defaults to ApiLimitPolicy.FAIL).

  Overrides:

  setApiLimitPolicy in class TwitterReader

• open

  public void open() throws DataException

  Description copied from class: DataEndpoint

  Makes this endpoint ready for reading or writing.

  Overrides:

  open in class TwitterReader

  Throws:

  DataException

• getPageImpl

  protected abstract C getPageImpl(long page, int pageSize) throws Throwable

  Fetches the page at the given cursor, requesting pageSize elements.

  Throws:

  Throwable

• addPageToBuffer

  protected abstract void addPageToBuffer(C list, LinkedList<E> buffer) throws Throwable

  Appends the elements of a fetched page to the buffer of elements still to be returned.

  Throws:

  Throwable

• copyToRecord

  protected abstract void copyToRecord(E element, Record record, IEntityExpansionPolicy entityExpansionPolicy) throws Throwable

  Populates a new, empty record from one buffered element.

  Throws:

  Throwable

• readImpl

  protected Record readImpl() throws Throwable

  Description copied from class: DataReader

  Overridden by subclasses to read the next record from this DataReader. The default implementation of DataReader.read() now insures that this method will not be called again after it returns a null.

  If no record is available, null will be returned.

  Contract for subclasses (see also docs/authoring/DataReader.md):

  • Return null exactly once to signal end-of-stream.
  • Do not call this method directly — DataReader.read() is the template method that wraps exceptions, increments the record count, and tracks lineage.
  • Do not call DataEndpoint.incrementRecordCount() here; DataReader.read() already does.
  • Throw raw exceptions; DataReader.read() wraps them via exception(throwable).

  Specified by:

  readImpl in class DataReader

  Throws:

  Throwable

• addExceptionProperties

  public DataException addExceptionProperties(DataException exception)

  Description copied from class: Endpoint

  Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.

  Overrides:

  addExceptionProperties in class TwitterReader