Package com.exonum.client.request

Enum BlockFilteringOption

java.lang.Object
java.lang.Enum<BlockFilteringOption>
com.exonum.client.request.BlockFilteringOption
All Implemented Interfaces:
Serializable, Comparable<BlockFilteringOption>, java.lang.constant.Constable
public enum BlockFilteringOption
extends Enum<BlockFilteringOption>
Request option for filtering blocks.

  • Enum Constant Details

    • SKIP_EMPTY

      public static final BlockFilteringOption SKIP_EMPTY
      Skip empty blocks (containing no transactions). Only non-empty blocks will be returned in a response.

      Requesting the server to skip empty blocks when the client does not need them allows to save bandwidth and complete the request faster if a large number of blocks is requested. However, some blockchains never have empty blocks, in which case this option has no effect (e.g., an active time oracle service will execute transactions after each block to keep time synchronized).

    • INCLUDE_EMPTY

      public static final BlockFilteringOption INCLUDE_EMPTY
      Include all blocks in a response (both empty and non-empty).

  • Method Details

    • values

      public static BlockFilteringOption[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static BlockFilteringOption valueOf​(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null