1 package org.apache.maven.shared.utils.cli.javatool;
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 org.apache.maven.shared.utils.cli.StreamConsumer;
23
24 /**
25 * Specifies the minimum parameters used to control a {@link JavaTool} invocation.
26 *
27 * @author <a href="mailto:chemit@codelutin.com">Tony Chemit</a>
28 * @since 0.5
29 */
30 public interface JavaToolRequest
31 {
32
33 /**
34 * <p>Gets the value of the {@code systemOutStreamConsumer} field.</p>
35 * <p>This option field if filled is used by the commandline tool to consume system ouput stream of the jarsigner
36 * command.</p>
37 *
38 * @return the value of the {@code systemOutStreamConsumer} field.
39 */
40 StreamConsumer getSystemOutStreamConsumer();
41
42 /**
43 * <p>Gets the value of the {@code systemErrorStreamConsumer} field.</p>
44 * <p>This option field if filled is used by the commandline tool to consume system error stream of the jarsigner
45 * command.</p>
46 *
47 * @return the value of the {@code systemErrorStreamConsumer} field.
48 */
49 StreamConsumer getSystemErrorStreamConsumer();
50
51 /**
52 * Sets the new given value to the field {@code systemOutStreamConsumer} of the request.
53 *
54 * @param systemOutStreamConsumer the new value of the field {@code systemOutStreamConsumer}.
55 */
56 void setSystemOutStreamConsumer( StreamConsumer systemOutStreamConsumer );
57
58 /**
59 * Sets the new given value to the field {@code systemErrorStreamConsumer} of the request.
60 *
61 * @param systemErrorStreamConsumer the new value of the field {@code systemErrorStreamConsumer}.
62 */
63 void setSystemErrorStreamConsumer( StreamConsumer systemErrorStreamConsumer );
64 }