/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
package org.apache.tools.ant.input;
Encapsulates an input request.
Since: Ant 1.5
/**
* Encapsulates an input request.
*
* @since Ant 1.5
*/
public class InputRequest {
private final String prompt;
private String input;
private String defaultValue;
Construct an InputRequest.
Params: - prompt – The prompt to show to the user. Must not be null.
/**
* Construct an InputRequest.
* @param prompt The prompt to show to the user. Must not be null.
*/
public InputRequest(String prompt) {
if (prompt == null) {
throw new IllegalArgumentException("prompt must not be null");
}
this.prompt = prompt;
}
Retrieves the prompt text.
Returns: the prompt.
/**
* Retrieves the prompt text.
* @return the prompt.
*/
public String getPrompt() {
return prompt;
}
Sets the user provided input.
Params: - input – the string to be used for input.
/**
* Sets the user provided input.
* @param input the string to be used for input.
*/
public void setInput(String input) {
this.input = input;
}
Is the user input valid?
Returns: true if it is.
/**
* Is the user input valid?
* @return true if it is.
*/
public boolean isInputValid() {
return true;
}
Retrieves the user input.
Returns: the user input.
/**
* Retrieves the user input.
* @return the user input.
*/
public String getInput() {
return input;
}
Gets a configured default value.
Returns: the default value. Since: Ant 1.7.0
/**
* Gets a configured default value.
* @return the default value.
* @since Ant 1.7.0
*/
public String getDefaultValue() {
return defaultValue;
}
Configures a default value.
Params: - d – the value to set.
Since: Ant 1.7.0
/**
* Configures a default value.
* @param d the value to set.
* @since Ant 1.7.0
*/
public void setDefaultValue(String d) {
defaultValue = d;
}
}