Interface AbstractConfigurationBuilder.Param

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getDefaultValue()
      The default value used when not set explicitly.
      java.lang.String getDescription()
      A description of this parameter used when printing usage.
      java.lang.String getName()
      The name of the parameter as it would appear on the command-line.
      java.lang.String getType()
      A string representation of the parameter type.
      boolean isRequired()
      Indicates whether or not this parameter is required and must therefore be set before the configuration can be successfully built.
      void setValue​(Configuration config, java.lang.String value)
      Sets this parameter on the given configuration instance.
    • Method Detail

      • getName

        java.lang.String getName()
        The name of the parameter as it would appear on the command-line.
      • getType

        java.lang.String getType()
        A string representation of the parameter type. If not applicable, just returns an empty string.
      • getDescription

        java.lang.String getDescription()
        A description of this parameter used when printing usage.
      • getDefaultValue

        java.lang.String getDefaultValue()
        The default value used when not set explicitly. Ignored if isRequired() is true.
      • isRequired

        boolean isRequired()
        Indicates whether or not this parameter is required and must therefore be set before the configuration can be successfully built.
      • setValue

        void setValue​(Configuration config,
                      java.lang.String value)
        Sets this parameter on the given configuration instance.