View Javadoc

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 Tony Chemit <chemit@codelutin.com>
28   * @since 0.5
29   */
30  public interface JavaToolRequest
31  {
32  
33      /**
34       * Gets the value of the {@code systemOutStreamConsumer} field.
35       * <p/>
36       * This option field if filled is used by the commandline tool to consume system ouput stream of the jarsigner
37       * command.
38       *
39       * @return the value of the {@code systemOutStreamConsumer} field.
40       */
41      StreamConsumer getSystemOutStreamConsumer();
42  
43      /**
44       * Gets the value of the {@code systemErrorStreamConsumer} field.
45       * <p/>
46       * This option field if filled is used by the commandline tool to consume system error stream of the jarsigner
47       * command.
48       *
49       * @return the value of the {@code systemErrorStreamConsumer} field.
50       */
51      StreamConsumer getSystemErrorStreamConsumer();
52  
53      /**
54       * Sets the new given value to the field {@code systemOutStreamConsumer} of the request.
55       *
56       * @param systemOutStreamConsumer the new value of the field {@code systemOutStreamConsumer}.
57       */
58      void setSystemOutStreamConsumer( StreamConsumer systemOutStreamConsumer );
59  
60      /**
61       * Sets the new given value to the field {@code systemErrorStreamConsumer} of the request.
62       *
63       * @param systemErrorStreamConsumer the new value of the field {@code systemErrorStreamConsumer}.
64       */
65      void setSystemErrorStreamConsumer( StreamConsumer systemErrorStreamConsumer );
66  }