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