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