Enum Class CountPolicy

java.lang.Object
java.lang.Enum<CountPolicy>
org.forgerock.json.resource.CountPolicy
All Implemented Interfaces:
Serializable, Comparable<CountPolicy>, Constable

public enum CountPolicy extends Enum<CountPolicy>
An enum of count policy types.
See Also:
  • Enum Constant Details

    • NONE

      public static final CountPolicy NONE
      There should be no count returned. No overhead should be incurred.
    • ESTIMATE

      public static final CountPolicy ESTIMATE
      Estimated count may be used. If no estimation is available it is up to the implementor whether to return an EXACT count or NONE. It should be known to the client which was used as in QueryResponse.getTotalPagedResultsPolicy()
    • EXACT

      public static final CountPolicy EXACT
      Exact count is required.
  • Method Details

    • values

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

      public static CountPolicy valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null