org.apache.tools.ant.input.InputHandler Maven / Gradle / Ivy
/*
* 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;
import org.apache.tools.ant.BuildException;
/**
* Plugin to Ant to handle requests for user input.
*
* @since Ant 1.5
*/
public interface InputHandler {
/**
* Handle the request encapsulated in the argument.
*
* Precondition: the request.getPrompt will return a non-null
* value.
*
* Postcondition: request.getInput will return a non-null
* value, request.isInputValid will return true.
* @param request the request to be processed
* @throws BuildException if the input cannot be read from the console
*/
void handleInput(InputRequest request)
throws BuildException;
}