Package net.jqwik.api

Enum ShrinkingMode

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ShrinkingMode>
    @API(status=MAINTAINED,
     since="1.0")
public enum ShrinkingMode
extends java.lang.Enum<ShrinkingMode>
    The shrinking mode defines the shrinking behaviour of a property. It can be set in Property.shrinking() for any property method; default is BOUNDED.
    See Also:
    Property

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOUNDED
      Shrinking is tried to a depth of 1000 steps maximum per value.
      FULL
      Shrinking continues until no smaller value can be found that also falsifies the property.
      NOT_SET  
      OFF
      No shrinking for falsified values.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ShrinkingMode valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ShrinkingMode[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • OFF

        public static final ShrinkingMode OFF
        No shrinking for falsified values.

      • BOUNDED

        public static final ShrinkingMode BOUNDED
        Shrinking is tried to a depth of 1000 steps maximum per value. If shrinking has not finished by then, the best found value is taken and bounded shrinking is reported through JUnit's reporting mechanism.

      • FULL

        public static final ShrinkingMode FULL
        Shrinking continues until no smaller value can be found that also falsifies the property. This might take very long or not end at all in rare cases.

      • NOT_SET

        @API(status=INTERNAL)
public static final ShrinkingMode NOT_SET

    • Method Detail

      • values

        public static ShrinkingMode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ShrinkingMode c : ShrinkingMode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ShrinkingMode valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null