Package org.instancio.settings

Class Keys

java.lang.Object
org.instancio.settings.Keys
public final class Keys extends Object
Defines all keys supported by Instancio.

  • Field Details

    • ARRAY_ELEMENTS_NULLABLE

      public static final SettingKey ARRAY_ELEMENTS_NULLABLE
      Specifies whether a null can be generated for array elements, default is false.

    • ARRAY_MAX_LENGTH

      public static final SettingKey ARRAY_MAX_LENGTH
      Specifies maximum length for arrays, default is 6.

    • ARRAY_MIN_LENGTH

      public static final SettingKey ARRAY_MIN_LENGTH
      Specifies minimum length for arrays, default is 2.

    • ARRAY_NULLABLE

      public static final SettingKey ARRAY_NULLABLE
      Specifies whether a null can be generated for arrays, default is false.

    • BOOLEAN_NULLABLE

      public static final SettingKey BOOLEAN_NULLABLE
      Specifies whether a null can be generated for Boolean type, default is false.

    • BYTE_MAX

      public static final SettingKey BYTE_MAX
      Specifies maximum value for bytes, default value is 127.

    • BYTE_MIN

      public static final SettingKey BYTE_MIN
      Specifies minimum value for bytes, default value is 1.

    • BYTE_NULLABLE

      public static final SettingKey BYTE_NULLABLE
      Specifies whether a null can be generated for Byte type, default is false.

    • CHARACTER_NULLABLE

      public static final SettingKey CHARACTER_NULLABLE
      Specifies whether a null can be generated for Character type, default is false.

    • COLLECTION_ELEMENTS_NULLABLE

      public static final SettingKey COLLECTION_ELEMENTS_NULLABLE
      Specifies whether a null can be generated for collection elements, default is false.

    • COLLECTION_MAX_SIZE

      public static final SettingKey COLLECTION_MAX_SIZE
      Specifies maximum size for collections, default is 6.

    • COLLECTION_MIN_SIZE

      public static final SettingKey COLLECTION_MIN_SIZE
      Specifies minimum size for collections, default is 2.

    • COLLECTION_NULLABLE

      public static final SettingKey COLLECTION_NULLABLE
      Specifies whether a null can be generated for collections, default is false.

    • DOUBLE_MAX

      public static final SettingKey DOUBLE_MAX
      Specifies maximum value for doubles, default value is 10000.

    • DOUBLE_MIN

      public static final SettingKey DOUBLE_MIN
      Specifies minimum value for doubles, default value is 1.0.

    • DOUBLE_NULLABLE

      public static final SettingKey DOUBLE_NULLABLE
      Specifies whether a null can be generated for Double type, default is false.

    • FLOAT_MAX

      public static final SettingKey FLOAT_MAX
      Specifies maximum value for floats, default value is 10000.

    • FLOAT_MIN

      public static final SettingKey FLOAT_MIN
      Specifies minimum value for floats, default value is 1.

    • FLOAT_NULLABLE

      public static final SettingKey FLOAT_NULLABLE
      Specifies whether a null can be generated for Float type, default is false.

    • INTEGER_MAX

      public static final SettingKey INTEGER_MAX
      Specifies maximum value for integers, default value is 10000.

    • INTEGER_MIN

      public static final SettingKey INTEGER_MIN
      Specifies minimum value for integers, default value is 1.

    • INTEGER_NULLABLE

      public static final SettingKey INTEGER_NULLABLE
      Specifies whether a null can be generated for Integer type, default is false.

    • LONG_MAX

      public static final SettingKey LONG_MAX
      Specifies maximum value for longs, default value is 10000.

    • LONG_MIN

      public static final SettingKey LONG_MIN
      Specifies minimum value for longs, default value is 1.

    • LONG_NULLABLE

      public static final SettingKey LONG_NULLABLE
      Specifies whether a null can be generated for Long type, default is false.

    • MAP_KEYS_NULLABLE

      public static final SettingKey MAP_KEYS_NULLABLE
      Specifies whether a null can be generated for map keys, default is false.

    • MAP_MAX_SIZE

      public static final SettingKey MAP_MAX_SIZE
      Specifies maximum size for maps, default is 6.

    • MAP_MIN_SIZE

      public static final SettingKey MAP_MIN_SIZE
      Specifies minimum size for maps, default is 2.

    • MAP_NULLABLE

      public static final SettingKey MAP_NULLABLE
      Specifies whether a null can be generated for maps, default is false.

    • MAP_VALUES_NULLABLE

      public static final SettingKey MAP_VALUES_NULLABLE
      Specifies whether a null can be generated for map values, default is false.

    • MODE

      public static final SettingKey MODE
      Specifies the mode: strict (unused selectors will trigger an exception) or lenient; default is strict.
      Since:
      1.3.3

    • SHORT_MAX

      public static final SettingKey SHORT_MAX
      Specifies maximum value for shorts, default value is 10000.

    • SHORT_MIN

      public static final SettingKey SHORT_MIN
      Specifies minimum value for shorts, default value is 1.

    • SHORT_NULLABLE

      public static final SettingKey SHORT_NULLABLE
      Specifies whether a null can be generated for Short type, default is false.

    • STRING_ALLOW_EMPTY

      public static final SettingKey STRING_ALLOW_EMPTY
      Specifies whether an empty string can be generated, default is false.

    • STRING_MAX_LENGTH

      public static final SettingKey STRING_MAX_LENGTH
      Specifies maximum length of strings, default is 10.

    • STRING_MIN_LENGTH

      public static final SettingKey STRING_MIN_LENGTH
      Specifies minimum length of strings, default is 3.

    • STRING_NULLABLE

      public static final SettingKey STRING_NULLABLE
      Specifies whether a null can be generated for String type, default is false.

  • Method Details

    • all

      public static List<SettingKey> all()
      Returns all keys supported by Instancio.
      Returns:
      all keys

    • get

      public static SettingKey get(String key)
      Returns a SettingKey instance with the given property key.
      Parameters:
      key - to lookup
      Returns:
      the setting key; an exception is thrown if the key is not found