Class StringParameter

    • Constructor Detail

      • StringParameter

        public StringParameter​(OptionID optionID,
                               java.lang.String defaultValue)
        Constructs a string parameter with the given optionID, and default value.
        Parameters:
        optionID - the unique id of the parameter
        defaultValue - the default value of the parameter
      • StringParameter

        public StringParameter​(OptionID optionID)
        Constructs a string parameter with the given optionID.
        Parameters:
        optionID - the unique id of the parameter
    • Method Detail

      • getValueAsString

        public java.lang.String getValueAsString()
        Description copied from interface: Parameter
        Get the value as string. May return null
        Returns:
        Value as string
      • getSyntax

        public java.lang.String getSyntax()
        Returns a string representation of the parameter's type.
        Returns:
        "<string>"
      • grab

        public boolean grab​(Parameterization config,
                            java.util.function.Consumer<java.lang.String> consumer)
        Get the parameter.
        Parameters:
        config - Parameterization
        consumer - Output consumer
        Returns:
        true if valid