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