Class DispatcherMeta.Field

java.lang.Object
org.codehaus.plexus.components.secdispatcher.DispatcherMeta.Field
Enclosing interface:
DispatcherMeta

public static final class DispatcherMeta.Field extends Object
  • Field Details

    • key

      private final String key
    • optional

      private final boolean optional
    • defaultValue

      private final String defaultValue
    • description

      private final String description
    • options

      private final List<DispatcherMeta.Field> options
  • Constructor Details

  • Method Details

    • getKey

      public String getKey()
      The key to be used in configuration map for field.
    • isOptional

      public boolean isOptional()
      Is configuration optional?
    • getDefaultValue

      public Optional<String> getDefaultValue()
      Optional default value of the configuration.
    • getDescription

      public String getDescription()
      The human description of the configuration.
    • getOptions

      public Optional<List<DispatcherMeta.Field>> getOptions()
      Optional list of options, if this configuration accepts limited values. Each option is represented as field, where getKey() represents the value to be used, and DispatcherMeta.displayName() represents the description of option. The getDefaultValue(), if present represents the value to be used instead of getKey().
    • builder

      public static DispatcherMeta.Field.Builder builder(String key)