1. /*
  2. * Copyright 2002,2004 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. package org.apache.tools.ant.input;
  18. /**
  19. * Plugin to Ant to handle requests for user input.
  20. *
  21. * @version $Revision: 1.5.2.4 $
  22. * @since Ant 1.5
  23. */
  24. public interface InputHandler {
  25. /**
  26. * Handle the request encapsulated in the argument.
  27. *
  28. * <p>Precondition: the request.getPrompt will return a non-null
  29. * value.</p>
  30. *
  31. * <p>Postcondition: request.getInput will return a non-null
  32. * value, request.isInputValid will return true.</p>
  33. * @param request the request to be processed
  34. * @throws org.apache.tools.ant.BuildException if the input cannot be read from the console
  35. */
  36. void handleInput(InputRequest request)
  37. throws org.apache.tools.ant.BuildException;
  38. }