Package com.github.toolarium.enumeration.configuration.annotation

Annotation Type EnumConfiguration

  • @Target(TYPE)
@Retention(RUNTIME)
@Inherited
@Documented
public @interface EnumConfiguration
    Defines the enumeration as a simple configuration as a set.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String description
      Defines the description of the enumeration configuration.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String tag
      Defines the tag of the enumeration configuration, which is optional and can be used for identify specific enum configurations.
      java.lang.String validFrom
      Defines the valid from date of the enumeration configuration.
      java.lang.String validTill
      Defines the valid till date of the enumeration configuration.

    • Element Detail

      • description

        java.lang.String description
        Defines the description of the enumeration configuration.
        Returns:
        The description of the enumeration configuration.

      • tag

        java.lang.String tag
        Defines the tag of the enumeration configuration, which is optional and can be used for identify specific enum configurations.
        Returns:
        The tag of the enumeration configuration.
        Default:
        ""

      • validFrom

        java.lang.String validFrom
        Defines the valid from date of the enumeration configuration. By default it's empty which means the current timestamp: DateTimeFormatter.ISO_INSTANT.format(Instant.now().truncatedTo(ChronoUnit.MILLIS)).
        Returns:
        The valid from information
        Default:
        ""

      • validTill

        java.lang.String validTill
        Defines the valid till date of the enumeration configuration. By default it's the "max" timestamp.
        Returns:
        The valid till information
        Default:
        "9999-12-31T12:00:00.000Z"