Class Input

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class Input
    extends Task
    Reads an input line from the console.
    Since:
    Ant 1.5
    • Constructor Detail

      • Input

        public Input()
    • Method Detail

      • setValidargs

        public void setValidargs​(java.lang.String validargs)
        Defines valid input parameters as comma separated strings. If set, input task will reject any input not defined as accepted and requires the user to reenter it. Validargs are case sensitive. If you want 'a' and 'A' to be accepted you need to define both values as accepted arguments.
        Parameters:
        validargs - A comma separated String defining valid input args.
      • setAddproperty

        public void setAddproperty​(java.lang.String addproperty)
        Defines the name of a property to be created from input. Behaviour is according to property task which means that existing properties cannot be overridden.
        Parameters:
        addproperty - Name for the property to be created from input
      • setMessage

        public void setMessage​(java.lang.String message)
        Sets the Message which gets displayed to the user during the build run.
        Parameters:
        message - The message to be displayed.
      • setDefaultvalue

        public void setDefaultvalue​(java.lang.String defaultvalue)
        Defines the default value of the property to be created from input. Property value will be set to default if not input is received.
        Parameters:
        defaultvalue - Default value for the property if no input is received
      • addText

        public void addText​(java.lang.String msg)
        Set a multiline message.
        Parameters:
        msg - The message to be displayed.
      • createHandler

        public Input.Handler createHandler()
        Create a nested handler element.
        Returns:
        a Handler for this Input task.