| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <!-- Generated by Apache Maven Doxia at Feb 7, 2012 --> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> |
| <title> |
| tycho-compiler:testCompile</title> |
| <style type="text/css" media="all"> |
| @import url("./css/maven-base.css"); |
| @import url("./css/maven-theme.css"); |
| @import url("./css/site.css"); |
| </style> |
| <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" /> |
| <meta name="Date-Revision-yyyymmdd" content="20120207" /> |
| <meta http-equiv="Content-Language" content="en" /> |
| |
| </head> |
| <body class="composite"> |
| <div id="banner"> |
| <div id="bannerLeft"> |
| Tycho OSGi Compiler Plugin (Incubation) |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="breadcrumbs"> |
| |
| |
| <div class="xleft"> |
| <span id="publishDate">Last Published: 2012-02-07</span> |
| | <span id="projectVersion">Version: 0.14.0</span> |
| </div> |
| <div class="xright"> <a href="http://wiki.eclipse.org/Development_Resources/HOWTO/Incubation_Phase#.281.29_What_Is_Incubation.3F" class="externalLink" title="This content is PRELIMINARY API and still subject to change">This content is PRELIMINARY API and still subject to change</a> |
| |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| <div id="leftColumn"> |
| <div id="navcolumn"> |
| |
| |
| <h5>Tycho</h5> |
| <ul> |
| <li class="none"> |
| <a href="../index.html" title="Introduction">Introduction</a> |
| </li> |
| <li class="none"> |
| <a href="../tycho-compiler-plugin/plugin-info.html" title="Compiler Plugin">Compiler Plugin</a> |
| </li> |
| <li class="none"> |
| <a href="../tycho-packaging-plugin/plugin-info.html" title="Packaging Plugin">Packaging Plugin</a> |
| </li> |
| <li class="none"> |
| <a href="../tycho-source-plugin/plugin-info.html" title="Source Plugin">Source Plugin</a> |
| </li> |
| <li class="none"> |
| <a href="../tycho-surefire/tycho-surefire-plugin/plugin-info.html" title="Surefire Plugin">Surefire Plugin</a> |
| </li> |
| <li class="none"> |
| <a href="../tycho-release/tycho-versions-plugin/plugin-info.html" title="Versions Plugin">Versions Plugin</a> |
| </li> |
| <li class="none"> |
| <a href="../tycho-p2/tycho-p2-director-plugin/plugin-info.html" title="P2 Director Plugin">P2 Director Plugin</a> |
| </li> |
| <li class="none"> |
| <a href="../tycho-p2/tycho-p2-repository-plugin/plugin-info.html" title="P2 Repository Plugin">P2 Repository Plugin</a> |
| </li> |
| </ul> |
| <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy"> |
| <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /> |
| </a> |
| |
| |
| </div> |
| </div> |
| <div id="bodyColumn"> |
| <div id="contentBox"> |
| |
| |
| <div class="section"><h2>tycho-compiler:testCompile<a name="tycho-compiler:testCompile"></a></h2> |
| <p><b>Full name</b>:</p> |
| <p>org.eclipse.tycho:tycho-compiler-plugin:0.14.0:testCompile</p> |
| <p><b>Description</b>:</p> |
| <div>(no description)</div> |
| <p><b>Attributes</b>:</p> |
| <ul> |
| <li>Requires a Maven project to be executed.</li> |
| <li>Requires dependency resolution of artifacts in scope: <tt>test</tt>.</li> |
| <li>Binds by default to the lifecycle phase: <tt>test-compile</tt>.</li> |
| </ul> |
| <div class="section"><h3>Optional Parameters<a name="Optional_Parameters"></a></h3> |
| <table class="bodyTable" border="0"> |
| <tr class="a"> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#compilerArgument">compilerArgument</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td><p>Unformatted argument string to be passed to the compiler if fork |
| is set to true.</p> |
| <p>This is because the list of valid arguments passed to a Java |
| compiler varies based on the compiler version.</p><br /></td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#compilerArguments">compilerArguments</a></b></td> |
| <td><tt>Map</tt></td> |
| <td><tt>-</tt></td> |
| <td><p>Arguments to be passed to the compiler (prepending a dash) if |
| fork is set to true.</p> |
| <p>This is because the list of valid arguments passed to a Java |
| compiler varies based on the compiler version.</p><br /></td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#compilerId">compilerId</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>The compiler id of the compiler to use.<br /><b>Default value is</b>: <tt>jdt</tt>.</td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#compilerVersion">compilerVersion</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>Version of the compiler to use, ex. "1.3", "1.5", if fork is set to |
| true<br /></td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#debug">debug</a></b></td> |
| <td><tt>boolean</tt></td> |
| <td><tt>-</tt></td> |
| <td>Whether to include debugging information in the compiled class |
| files. The default value is true.<br /><b>Default value is</b>: <tt>true</tt>.</td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#encoding">encoding</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>The -encoding argument for the Java compiler<br /></td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#excludeResources">excludeResources</a></b></td> |
| <td><tt>Set</tt></td> |
| <td><tt>-</tt></td> |
| <td>A list of exclusion filters for non-java resource files which |
| should not be copied to the output directory.<br /></td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#excludes">excludes</a></b></td> |
| <td><tt>Set</tt></td> |
| <td><tt>-</tt></td> |
| <td>A list of exclusion filters for the compiler.<br /></td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#executable">executable</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>The executable of the compiler to use when fork is true.<br /></td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#extraClasspathElements">extraClasspathElements</a></b></td> |
| <td><tt>MavenArtifactRef[]</tt></td> |
| <td><tt>-</tt></td> |
| <td>Transitively add specified maven artifacts to compile classpath in |
| addition to elements calculated according to OSGi rules. All |
| packages from additional entries will be accessible at compile |
| time. Useful when OSGi runtime classpath contains elements not |
| defined using normal dependency mechanisms. For example, when |
| Eclipse Equinox is started from application server with |
| -Dosgi.parentClassloader=fwk parameter. DO NOT USE. This is a |
| stopgap solution to allow refactoring of tycho-p2 code to a |
| separate set of components.<br /></td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#fork">fork</a></b></td> |
| <td><tt>boolean</tt></td> |
| <td><tt>-</tt></td> |
| <td>Allows running the compiler in a separate process. If "false" it |
| uses the built in compiler, while if "true" it will use an |
| executable.<br /><b>Default value is</b>: <tt>false</tt>.</td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#includes">includes</a></b></td> |
| <td><tt>Set</tt></td> |
| <td><tt>-</tt></td> |
| <td>A list of inclusion filters for the compiler.<br /></td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#maxmem">maxmem</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>maximum size, in megabytes, of the memory allocation pool, ex. |
| "128", "128m" if fork is set to true<br /></td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#meminitial">meminitial</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>Initial size, in megabytes, of the memory allocation pool, ex. |
| "64", "64m" if fork is set to true<br /></td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#optimize">optimize</a></b></td> |
| <td><tt>boolean</tt></td> |
| <td><tt>-</tt></td> |
| <td>Optimize compiled code using the compiler's optimization methods<br /><b>Default value is</b>: <tt>false</tt>.</td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#outputFileName">outputFileName</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>Used to control the name of the output file when compiling a set of |
| sources to a single file.<br /></td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#showDeprecation">showDeprecation</a></b></td> |
| <td><tt>boolean</tt></td> |
| <td><tt>-</tt></td> |
| <td>Output source locations where deprecated APIs are used<br /><b>Default value is</b>: <tt>false</tt>.</td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#showWarnings">showWarnings</a></b></td> |
| <td><tt>boolean</tt></td> |
| <td><tt>-</tt></td> |
| <td>Output warnings<br /><b>Default value is</b>: <tt>false</tt>.</td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#source">source</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>The -source argument for the Java compiler<br /></td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#staleMillis">staleMillis</a></b></td> |
| <td><tt>int</tt></td> |
| <td><tt>-</tt></td> |
| <td>The granularity in milliseconds of the last modification date for |
| testing whether a source needs recompilation<br /><b>Default value is</b>: <tt>0</tt>.</td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#target">target</a></b></td> |
| <td><tt>String</tt></td> |
| <td><tt>-</tt></td> |
| <td>The -target argument for the Java compiler<br /></td> |
| </tr> |
| <tr class="a"> |
| <td><b><a href="#useJDK">useJDK</a></b></td> |
| <td><tt>JDKUsage</tt></td> |
| <td><tt>-</tt></td> |
| <td>Which JDK to use for compilation. Default value is SYSTEM which |
| means the currently running JDK. If BREE is specified, MANIFEST |
| header <tt>Bundle-RequiredExecutionEnvironment</tt> is used to |
| define the JDK to compile against. In this case, you need to |
| provide a <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-using-toolchains.html">toolchains.xml</a> |
| configuration file. The value of BREE will be matched against the |
| id of the toolchain elements in toolchains.xml. Example: |
| <div><pre> |
| <toolchains> |
| <toolchain> |
| <type>jdk</type> |
| <provides> |
| <id>J2SE-1.5</id> |
| </provides> |
| <configuration> |
| <jdkHome>/path/to/jdk/1.5</jdkHome> |
| </configuration> |
| </toolchain> |
| </toolchains> |
| </pre></div><br /><b>Default value is</b>: <tt>SYSTEM</tt>.</td> |
| </tr> |
| <tr class="b"> |
| <td><b><a href="#verbose">verbose</a></b></td> |
| <td><tt>boolean</tt></td> |
| <td><tt>-</tt></td> |
| <td>Whether to output messages about what the compiler is doing<br /><b>Default value is</b>: <tt>false</tt>.</td> |
| </tr> |
| </table> |
| </div> |
| <div class="section"><h3>Parameter Details<a name="Parameter_Details"></a></h3> |
| <p><b><a name="compilerArgument">compilerArgument</a>:</b></p> |
| <div><p>Unformatted argument string to be passed to the compiler if fork |
| is set to true.</p> |
| <p>This is because the list of valid arguments passed to a Java |
| compiler varies based on the compiler version.</p></div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /><p><b><a name="compilerArguments">compilerArguments</a>:</b></p> |
| <div><p>Arguments to be passed to the compiler (prepending a dash) if |
| fork is set to true.</p> |
| <p>This is because the list of valid arguments passed to a Java |
| compiler varies based on the compiler version.</p></div> |
| <ul> |
| <li><b>Type</b>: <tt>java.util.Map</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /><p><b><a name="compilerId">compilerId</a>:</b></p> |
| <div>The compiler id of the compiler to use.</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.compilerId}</tt></li> |
| <li><b>Default</b>: <tt>jdt</tt></li> |
| </ul><hr /><p><b><a name="compilerVersion">compilerVersion</a>:</b></p> |
| <div>Version of the compiler to use, ex. "1.3", "1.5", if fork is set to |
| true</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.compilerVersion}</tt></li> |
| </ul><hr /><p><b><a name="debug">debug</a>:</b></p> |
| <div>Whether to include debugging information in the compiled class |
| files. The default value is true.</div> |
| <ul> |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.debug}</tt></li> |
| <li><b>Default</b>: <tt>true</tt></li> |
| </ul><hr /><p><b><a name="encoding">encoding</a>:</b></p> |
| <div>The -encoding argument for the Java compiler</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.encoding}</tt></li> |
| </ul><hr /><p><b><a name="excludeResources">excludeResources</a>:</b></p> |
| <div>A list of exclusion filters for non-java resource files which |
| should not be copied to the output directory.</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.util.Set</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /><p><b><a name="excludes">excludes</a>:</b></p> |
| <div>A list of exclusion filters for the compiler.</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.util.Set</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /><p><b><a name="executable">executable</a>:</b></p> |
| <div>The executable of the compiler to use when fork is true.</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.executable}</tt></li> |
| </ul><hr /><p><b><a name="extraClasspathElements">extraClasspathElements</a>:</b></p> |
| <div>Transitively add specified maven artifacts to compile classpath in |
| addition to elements calculated according to OSGi rules. All |
| packages from additional entries will be accessible at compile |
| time. Useful when OSGi runtime classpath contains elements not |
| defined using normal dependency mechanisms. For example, when |
| Eclipse Equinox is started from application server with |
| -Dosgi.parentClassloader=fwk parameter. DO NOT USE. This is a |
| stopgap solution to allow refactoring of tycho-p2 code to a |
| separate set of components.</div> |
| <ul> |
| <li><b>Type</b>: <tt>org.eclipse.tycho.core.utils.MavenArtifactRef[]</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /><p><b><a name="fork">fork</a>:</b></p> |
| <div>Allows running the compiler in a separate process. If "false" it |
| uses the built in compiler, while if "true" it will use an |
| executable.</div> |
| <ul> |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /><p><b><a name="includes">includes</a>:</b></p> |
| <div>A list of inclusion filters for the compiler.</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.util.Set</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| </ul><hr /><p><b><a name="maxmem">maxmem</a>:</b></p> |
| <div>maximum size, in megabytes, of the memory allocation pool, ex. |
| "128", "128m" if fork is set to true</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.maxmem}</tt></li> |
| </ul><hr /><p><b><a name="meminitial">meminitial</a>:</b></p> |
| <div>Initial size, in megabytes, of the memory allocation pool, ex. |
| "64", "64m" if fork is set to true</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.meminitial}</tt></li> |
| </ul><hr /><p><b><a name="optimize">optimize</a>:</b></p> |
| <div>Optimize compiled code using the compiler's optimization methods</div> |
| <ul> |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.optimize}</tt></li> |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /><p><b><a name="outputFileName">outputFileName</a>:</b></p> |
| <div>Used to control the name of the output file when compiling a set of |
| sources to a single file.</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${project.build.finalName}</tt></li> |
| </ul><hr /><p><b><a name="showDeprecation">showDeprecation</a>:</b></p> |
| <div>Output source locations where deprecated APIs are used</div> |
| <ul> |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.showDeprecation}</tt></li> |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /><p><b><a name="showWarnings">showWarnings</a>:</b></p> |
| <div>Output warnings</div> |
| <ul> |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.showWarnings}</tt></li> |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul><hr /><p><b><a name="source">source</a>:</b></p> |
| <div>The -source argument for the Java compiler</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.source}</tt></li> |
| </ul><hr /><p><b><a name="staleMillis">staleMillis</a>:</b></p> |
| <div>The granularity in milliseconds of the last modification date for |
| testing whether a source needs recompilation</div> |
| <ul> |
| <li><b>Type</b>: <tt>int</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${lastModGranularityMs}</tt></li> |
| <li><b>Default</b>: <tt>0</tt></li> |
| </ul><hr /><p><b><a name="target">target</a>:</b></p> |
| <div>The -target argument for the Java compiler</div> |
| <ul> |
| <li><b>Type</b>: <tt>java.lang.String</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.target}</tt></li> |
| </ul><hr /><p><b><a name="useJDK">useJDK</a>:</b></p> |
| <div>Which JDK to use for compilation. Default value is SYSTEM which |
| means the currently running JDK. If BREE is specified, MANIFEST |
| header <tt>Bundle-RequiredExecutionEnvironment</tt> is used to |
| define the JDK to compile against. In this case, you need to |
| provide a <a class="externalLink" href="http://maven.apache.org/guides/mini/guide-using-toolchains.html">toolchains.xml</a> |
| configuration file. The value of BREE will be matched against the |
| id of the toolchain elements in toolchains.xml. Example: |
| <div><pre> |
| <toolchains> |
| <toolchain> |
| <type>jdk</type> |
| <provides> |
| <id>J2SE-1.5</id> |
| </provides> |
| <configuration> |
| <jdkHome>/path/to/jdk/1.5</jdkHome> |
| </configuration> |
| </toolchain> |
| </toolchains> |
| </pre></div></div> |
| <ul> |
| <li><b>Type</b>: <tt>org.eclipse.tycho.compiler.AbstractOsgiCompilerMojo.JDKUsage</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Default</b>: <tt>SYSTEM</tt></li> |
| </ul><hr /><p><b><a name="verbose">verbose</a>:</b></p> |
| <div>Whether to output messages about what the compiler is doing</div> |
| <ul> |
| <li><b>Type</b>: <tt>boolean</tt></li> |
| <li><b>Required</b>: <tt>No</tt></li> |
| <li><b>Expression</b>: <tt>${maven.compiler.verbose}</tt></li> |
| <li><b>Default</b>: <tt>false</tt></li> |
| </ul> |
| </div> |
| </div> |
| |
| |
| </div> |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| <div id="footer"> |
| <div class="xright"> |
| Copyright © 2008-2012 |
| <a href="http://www.eclipse.org/">Eclipse Foundation</a>. |
| All Rights Reserved. |
| |
| </div> |
| <div class="clear"> |
| <hr/> |
| </div> |
| </div> |
| </body> |
| </html> |
