Enum Class Maturity

java.lang.Object
java.lang.Enum<Maturity>
io.nosqlbench.nb.annotations.Maturity
All Implemented Interfaces:
Serializable, Comparable<Maturity>, Constable
public enum Maturity extends Enum<Maturity>
This is a way for NoSQLBench code and driver maintainers to communicate about the maturity of various components. There are no specific criteria for these designations for now. Developers should use their bet judgement about which to assign to any component. Guidelines to follow:
  • If the component is new, and hasn't had external user testing, it should be marked as Experimental.
  • If the component is being used by users or testers, it may be marked as Settling, but should not be marked as stable.
  • If the component has been in use for several releases, has user feedback about the quality and a low number of issues file specifically against it, then it may be marked as Stable.
  • Components which are marked stable should not be modified in place except for carefully compartmentalized and tested changes. If this is needed, then a new component selector under a different name should be used for those changes so that users and historic tests are not affected.
  • By default, the runtime will mark a component as Unspecified unless/until the maturity field is set of its Service annotation.

  • Enum Constant Details

    • Stable

      public static final Maturity Stable

    • Proven

      public static final Maturity Proven

    • Verified

      public static final Maturity Verified

    • Tested

      public static final Maturity Tested

    • Unspecified

      public static final Maturity Unspecified

    • Deprecated

      public static final Maturity Deprecated

    • Experimental

      public static final Maturity Experimental

    • Sketch

      public static final Maturity Sketch

    • Any

      public static final Maturity Any

  • Method Details

    • values

      public static Maturity[] 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 Maturity 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

    • getStability

      public int getStability()

    • getDescription

      public String getDescription()

    • equalOrGreater

      public boolean equalOrGreater(Maturity reference)