01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: *
17: */
18:
19: package org.apache.tools.ant.input;
20:
21: /**
22: * Plugin to Ant to handle requests for user input.
23: *
24: * @since Ant 1.5
25: */
26: public interface InputHandler {
27:
28: /**
29: * Handle the request encapsulated in the argument.
30: *
31: * <p>Precondition: the request.getPrompt will return a non-null
32: * value.</p>
33: *
34: * <p>Postcondition: request.getInput will return a non-null
35: * value, request.isInputValid will return true.</p>
36: * @param request the request to be processed
37: * @throws org.apache.tools.ant.BuildException if the input cannot be read from the console
38: */
39: void handleInput(InputRequest request)
40: throws org.apache.tools.ant.BuildException;
41: }
|