Package org.onyx.api

Class Feed.Builder<T>

java.lang.Object
org.onyx.api.Feed.Builder<T>
Direct Known Subclasses:
Feed.Action.Builder, Feed.Transaction.Builder
Enclosing class:
Feed<T>
public abstract static class Feed.Builder<T> extends Object

  • Field Details

    • type

      @Expose protected String type

  • Method Details

    • create

      public Feed<T> create(Client client) throws ChainException
      Creates a new feed for the ledger.
      Parameters:
      client - ledger API connection object
      Returns:
      a feed
      Throws:
      ChainException

    • setId

      public Feed.Builder<T> setId(String id)
      Specifies the id for the new feed.
      Parameters:
      id - unique identifier. Will be auto-generated if not provided.
      Returns:
      updated builder

    • setFilter

      public Feed.Builder<T> setFilter(String filter)
      Sets the filter expression for the feed.
      Parameters:
      filter - a filter expression
      Returns:
      updated builder

    • addFilterParameter

      public Feed.Builder<T> addFilterParameter(Object param)
      Adds a filter parameter that will be interpolated into the filter expression.
      Parameters:
      param - a filter parameter
      Returns:
      updated builder

    • setFilterParameters

      public Feed.Builder<T> setFilterParameters(List<?> params)
      Specifies the parameters that will be interpolated into the filter expression.
      Parameters:
      params - list of filter parameters