Coverage Report

Coverage Report - org.apache.maven.shared.invoker.Invoker

Classes in this File

Line Coverage

Branch Coverage

0/1

 package org.apache.maven.shared.invoker;
 
 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */
 
 import java.io.File;
 import java.io.InputStream;
 
 /**
  * Provides a facade to invoke Maven.
  * 
  * @version $Id: Invoker.java 662043 2008-05-31 16:27:02Z bentmann $
  */
 public interface Invoker
 {
 
     /**
      * The role name used to register implementations of this interface within Plexus.
      */
     String ROLE = Invoker.class.getName();
 
     /**
      * @deprecated Query this property by yourself, this has nothing to do with invoking Maven and as such does not
      *             belong into this API!
      */
     String userHome = System.getProperty( "user.home" );
 
     /**
      * Executes Maven using the parameters specified by the given invocation request. Parameters not specified by the
      * invocation request will be derived from the state of this invoker instance. In case both the invoker instance and
      * the invocation request provide a value for a particular option, the value from the invocation request dominates.
      * 
      * @param request The invocation request to execute, must not be <code>null</code>.
      * @return The result of the Maven invocation, never <code>null</code>.
      * @throws MavenInvocationException
      */
     InvocationResult execute( InvocationRequest request )
         throws MavenInvocationException;
 
     /**
      * Gets the path to the base directory of the local repository to use for the Maven invocation.
      * 
      * @return The path to the base directory of the local repository or <code>null</code> to use the location from
      *         the <code>settings.xml</code>.
      */
     File getLocalRepositoryDirectory();
 
     /**
      * Gets the working directory for the Maven invocation.
      * 
      * @return The working directory for the Maven invocation or <code>null</code> if the working directory is derived
      *         from the base directory of the processed POM.
      */
     File getWorkingDirectory();
 
     /**
      * Gets the logger used by this invoker to output diagnostic messages.
      * 
      * @return The logger used by this invoker to output diagnostic messages, never <code>null</code>.
      */
     InvokerLogger getLogger();
 
     /**
      * Gets the path to the base directory of the Maven installation used to invoke Maven.
      * 
      * @return The path to the base directory of the Maven installation or <code>null</code> if using the default
      *         Maven installation.
      */
     File getMavenHome();
 
     /**
      * Sets the path to the base directory of the Maven installation used to invoke Maven. This parameter may be left
      * unspecified to use the default Maven installation which will be discovered by evaluating the system property
      * <code>maven.home</code> and the environment variable <code>M2_HOME</code>.
      * 
      * @param mavenHome The path to the base directory of the Maven installation, may be <code>null</code> to use the
      *            default Maven installation.
      * @return This invoker instance.
      */
     Invoker setMavenHome( File mavenHome );
 
     /**
      * Sets the path to the base directory of the local repository to use for the Maven invocation.
      * 
      * @param localRepositoryDirectory The path to the base directory of the local repository or <code>null</code> to
      *            use the location from the <code>settings.xml</code>.
      * @return This invoker instance.
      */
     Invoker setLocalRepositoryDirectory( File localRepositoryDirectory );
 
     /**
      * Sets the logger used by this invoker to output diagnostic messages.
      * 
      * @param logger The logger used by this invoker to output diagnostic messages, may be <code>null</code> to use a
      *            default logger.
      * @return This invoker instance.
      */
     Invoker setLogger( InvokerLogger logger );
 
     /**
      * Sets the working directory for the Maven invocation.
      * 
      * @param workingDirectory The working directory for the Maven invocation, may be <code>null</code> to derive the
      *            working directory from the base directory of the processed POM.
      * @return This invoker instance.
      */
     Invoker setWorkingDirectory( File workingDirectory );
 
     /**
      * Sets the input stream used to provide input for the invoked Maven build. This is in particular useful when
      * invoking Maven in interactive mode.
      * 
      * @param inputStream The input stream used to provide input for the invoked Maven build, may be <code>null</code>
      *            if not required.
      * @return This invoker instance.
      */
     Invoker setInputStream( InputStream inputStream );
 
     /**
      * Sets the handler used to capture the standard output from the Maven build.
      * 
      * @param outputHandler The output handler, may be <code>null</code> if the output is not of interest.
      * @return This invoker instance.
      */
     Invoker setOutputHandler( InvocationOutputHandler outputHandler );
 
     /**
      * Sets the handler used to capture the error output from the Maven build.
      * 
      * @param errorHandler The error handler, may be <code>null</code> if the output is not of interest.
      * @return This invoker instance.
      */
     Invoker setErrorHandler( InvocationOutputHandler errorHandler );
 
 }

1		package org.apache.maven.shared.invoker;
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 java.io.File;
23		import java.io.InputStream;
24
25		/**
26		* Provides a facade to invoke Maven.
27		*
28		* @version $Id: Invoker.java 662043 2008-05-31 16:27:02Z bentmann $
29		*/
30		public interface Invoker
31		{
32
33		/**
34		* The role name used to register implementations of this interface within Plexus.
35		*/
36	0	String ROLE = Invoker.class.getName();
37
38		/**
39		* @deprecated Query this property by yourself, this has nothing to do with invoking Maven and as such does not
40		* belong into this API!
41		*/
42		String userHome = System.getProperty( "user.home" );
43
44		/**
45		* Executes Maven using the parameters specified by the given invocation request. Parameters not specified by the
46		* invocation request will be derived from the state of this invoker instance. In case both the invoker instance and
47		* the invocation request provide a value for a particular option, the value from the invocation request dominates.
48		*
49		* @param request The invocation request to execute, must not be <code>null</code>.
50		* @return The result of the Maven invocation, never <code>null</code>.
51		* @throws MavenInvocationException
52		*/
53		InvocationResult execute( InvocationRequest request )
54		throws MavenInvocationException;
55
56		/**
57		* Gets the path to the base directory of the local repository to use for the Maven invocation.
58		*
59		* @return The path to the base directory of the local repository or <code>null</code> to use the location from
60		* the <code>settings.xml</code>.
61		*/
62		File getLocalRepositoryDirectory();
63
64		/**
65		* Gets the working directory for the Maven invocation.
66		*
67		* @return The working directory for the Maven invocation or <code>null</code> if the working directory is derived
68		* from the base directory of the processed POM.
69		*/
70		File getWorkingDirectory();
71
72		/**
73		* Gets the logger used by this invoker to output diagnostic messages.
74		*
75		* @return The logger used by this invoker to output diagnostic messages, never <code>null</code>.
76		*/
77		InvokerLogger getLogger();
78
79		/**
80		* Gets the path to the base directory of the Maven installation used to invoke Maven.
81		*
82		* @return The path to the base directory of the Maven installation or <code>null</code> if using the default
83		* Maven installation.
84		*/
85		File getMavenHome();
86
87		/**
88		* Sets the path to the base directory of the Maven installation used to invoke Maven. This parameter may be left
89		* unspecified to use the default Maven installation which will be discovered by evaluating the system property
90		* <code>maven.home</code> and the environment variable <code>M2_HOME</code>.
91		*
92		* @param mavenHome The path to the base directory of the Maven installation, may be <code>null</code> to use the
93		* default Maven installation.
94		* @return This invoker instance.
95		*/
96		Invoker setMavenHome( File mavenHome );
97
98		/**
99		* Sets the path to the base directory of the local repository to use for the Maven invocation.
100		*
101		* @param localRepositoryDirectory The path to the base directory of the local repository or <code>null</code> to
102		* use the location from the <code>settings.xml</code>.
103		* @return This invoker instance.
104		*/
105		Invoker setLocalRepositoryDirectory( File localRepositoryDirectory );
106
107		/**
108		* Sets the logger used by this invoker to output diagnostic messages.
109		*
110		* @param logger The logger used by this invoker to output diagnostic messages, may be <code>null</code> to use a
111		* default logger.
112		* @return This invoker instance.
113		*/
114		Invoker setLogger( InvokerLogger logger );
115
116		/**
117		* Sets the working directory for the Maven invocation.
118		*
119		* @param workingDirectory The working directory for the Maven invocation, may be <code>null</code> to derive the
120		* working directory from the base directory of the processed POM.
121		* @return This invoker instance.
122		*/
123		Invoker setWorkingDirectory( File workingDirectory );
124
125		/**
126		* Sets the input stream used to provide input for the invoked Maven build. This is in particular useful when
127		* invoking Maven in interactive mode.
128		*
129		* @param inputStream The input stream used to provide input for the invoked Maven build, may be <code>null</code>
130		* if not required.
131		* @return This invoker instance.
132		*/
133		Invoker setInputStream( InputStream inputStream );
134
135		/**
136		* Sets the handler used to capture the standard output from the Maven build.
137		*
138		* @param outputHandler The output handler, may be <code>null</code> if the output is not of interest.
139		* @return This invoker instance.
140		*/
141		Invoker setOutputHandler( InvocationOutputHandler outputHandler );
142
143		/**
144		* Sets the handler used to capture the error output from the Maven build.
145		*
146		* @param errorHandler The error handler, may be <code>null</code> if the output is not of interest.
147		* @return This invoker instance.
148		*/
149		Invoker setErrorHandler( InvocationOutputHandler errorHandler );
150
151		}