1 package org.apache.maven.shared.utils.cli;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.IOException;
23
24 /**
25 * <p>Works in concert with the StreamPumper class to
26 * allow implementations to gain access to the lines being
27 * "Pumped".</p>
28 * <p>Please note that implementations of this interface can be expected to be
29 * called from arbitrary threads and must therefore be threadsafe.</p>
30 *
31 * @author <a href="mailto:fvancea@maxiq.com">Florin Vancea</a>
32 * @author <a href="mailto:pj@thoughtworks.com">Paul Julius</a>
33 */
34 public interface StreamConsumer
35 {
36 /**
37 * Called when the StreamPumper pumps a line from the Stream.
38 * @param line The line to be consumed.
39 * @throws IOException if consuming {@code line} fails.
40 */
41 void consumeLine( String line ) throws IOException;
42 }