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

Annotation Type EnumValueConfiguration

  • @Target(FIELD)
@Retention(SOURCE)
@Inherited
@Documented
public @interface EnumValueConfiguration
    Defines the enumeration as a value based configuration.

    • 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 defaultValue
      The default value.
      boolean isConfidential
      Determines whether the configuration value is confidential.
      boolean isOptional
      Determines whether the configuration is optional.
      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.

      • defaultValue

        java.lang.String defaultValue
        The default value.
        Returns:
        The default value.
        Default:
        ""

      • isOptional

        boolean isOptional
        Determines whether the configuration is optional. If the default value is empty, no configuration value is available. An empty configuration value with non-optional parameter marks a configuration value that must be defined.
        Returns:
        Define if the value is confidential.
        Default:
        false

      • isConfidential

        boolean isConfidential
        Determines whether the configuration value is confidential. In case of persistence it has to be secured.
        Returns:
        Define if the value is confidential.
        Default:
        false

      • 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.SECONDS)).
        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:00Z"