View Javadoc
1   package org.apache.maven.shared.release.exec;
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.codehaus.plexus.util.cli.Commandline;
23  
24  /**
25   * Create a command line for execution. Componentised to allow mocking.
26   *
27   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
28   */
29  public interface CommandLineFactory
30  {
31      /**
32       * Plexus role.
33       */
34      String ROLE = CommandLineFactory.class.getName();
35  
36      /**
37       * Create a command line object with default environment for the given executable.
38       *
39       * @param executable the executable
40       * @return the command line
41       * @throws MavenExecutorException if there was a problem creating the command line
42       */
43      Commandline createCommandLine( String executable )
44          throws MavenExecutorException;
45  }