/usr/share/doc/libmaven-plugin-testing-java/api/org/apache/maven/shared/test/plugin/ProjectTool.html is in libmaven-plugin-testing-java-doc 1.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_45) on Thu Jan 09 06:30:21 UTC 2014 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ProjectTool (Maven Plugin Testing 1.3 API)</title>
<meta name="date" content="2014-01-09">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ProjectTool (Maven Plugin Testing 1.3 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProjectTool.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/maven/shared/test/plugin/PluginTestTool.html" title="class in org.apache.maven.shared.test.plugin"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/maven/shared/test/plugin/RepositoryTool.html" title="class in org.apache.maven.shared.test.plugin"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/maven/shared/test/plugin/ProjectTool.html" target="_top">Frames</a></li>
<li><a href="ProjectTool.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.maven.shared.test.plugin</div>
<h2 title="Class ProjectTool" class="title">Class ProjectTool</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.maven.shared.test.plugin.ProjectTool</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ProjectTool</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Testing tool used to read MavenProject instances from pom.xml files, and to create plugin jar
files (package phase of the normal build process) for distribution to a test local repository
directory.</div>
<dl><dt><span class="strong">Version:</span></dt>
<dd>$Id: ProjectTool.java 1085807 2011-03-26 21:40:19Z hboutemy $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>jdcasey</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#INTEGRATION_TEST_DEPLOYMENT_REPO_URL">INTEGRATION_TEST_DEPLOYMENT_REPO_URL</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#ROLE">ROLE</a></strong></code>
<div class="block">Plexus role</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#ProjectTool()">ProjectTool</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected org.apache.maven.shared.test.plugin.ProjectTool.PomInfo</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#manglePomForTesting(java.io.File, java.lang.String, boolean)">manglePomForTesting</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> testVersion,
boolean skipUnitTests)</code>
<div class="block">Inject a special version for testing, to allow tests to unambiguously reference the plugin
currently under test.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.apache.maven.project.MavenProject</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#packageProjectArtifact(java.io.File, java.lang.String, boolean)">packageProjectArtifact</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> testVersion,
boolean skipUnitTests)</code>
<div class="block">Run the plugin's Maven build up to the package phase, in order to produce a jar file for
distribution to a test-time local repository.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.apache.maven.project.MavenProject</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#packageProjectArtifact(java.io.File, java.lang.String, boolean, java.io.File)">packageProjectArtifact</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> testVersion,
boolean skipUnitTests,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> logFile)</code>
<div class="block">Run the plugin's Maven build up to the package phase, in order to produce a jar file for
distribution to a test-time local repository.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.apache.maven.project.MavenProject</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#readProject(java.io.File)">readProject</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile)</code>
<div class="block">Construct a MavenProject instance from the specified POM file.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.apache.maven.project.MavenProject</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#readProject(java.io.File, java.io.File)">readProject</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> localRepositoryBasedir)</code>
<div class="block">Construct a MavenProject instance from the specified POM file, using the specified local
repository directory to resolve ancestor POMs as needed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.apache.maven.project.MavenProject</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#readProjectWithDependencies(java.io.File)">readProjectWithDependencies</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile)</code>
<div class="block">Construct a MavenProject instance from the specified POM file with dependencies.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>org.apache.maven.project.MavenProject</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/maven/shared/test/plugin/ProjectTool.html#readProjectWithDependencies(java.io.File, java.io.File)">readProjectWithDependencies</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> localRepositoryBasedir)</code>
<div class="block">Construct a MavenProject instance from the specified POM file with dependencies, using the specified local
repository directory to resolve ancestor POMs as needed.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="ROLE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ROLE</h4>
<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ROLE</pre>
<div class="block">Plexus role</div>
</li>
</ul>
<a name="INTEGRATION_TEST_DEPLOYMENT_REPO_URL">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>INTEGRATION_TEST_DEPLOYMENT_REPO_URL</h4>
<pre>public static final <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> INTEGRATION_TEST_DEPLOYMENT_REPO_URL</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.maven.shared.test.plugin.ProjectTool.INTEGRATION_TEST_DEPLOYMENT_REPO_URL">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ProjectTool()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ProjectTool</h4>
<pre>public ProjectTool()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="readProject(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readProject</h4>
<pre>public org.apache.maven.project.MavenProject readProject(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile)
throws <a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></pre>
<div class="block">Construct a MavenProject instance from the specified POM file.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pomFile</code> - current POM file</dd>
<dt><span class="strong">Returns:</span></dt><dd>the Maven project from a file</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></code> - if any</dd></dl>
</li>
</ul>
<a name="readProject(java.io.File, java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readProject</h4>
<pre>public org.apache.maven.project.MavenProject readProject(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> localRepositoryBasedir)
throws <a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></pre>
<div class="block">Construct a MavenProject instance from the specified POM file, using the specified local
repository directory to resolve ancestor POMs as needed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pomFile</code> - current POM file</dd><dd><code>localRepositoryBasedir</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the Maven project from a file and a local repo</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></code> - if any</dd></dl>
</li>
</ul>
<a name="readProjectWithDependencies(java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readProjectWithDependencies</h4>
<pre>public org.apache.maven.project.MavenProject readProjectWithDependencies(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile)
throws <a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></pre>
<div class="block">Construct a MavenProject instance from the specified POM file with dependencies.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pomFile</code> - current POM file</dd>
<dt><span class="strong">Returns:</span></dt><dd>the Maven project with dependencies from a file</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></code> - if any</dd></dl>
</li>
</ul>
<a name="readProjectWithDependencies(java.io.File, java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readProjectWithDependencies</h4>
<pre>public org.apache.maven.project.MavenProject readProjectWithDependencies(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> localRepositoryBasedir)
throws <a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></pre>
<div class="block">Construct a MavenProject instance from the specified POM file with dependencies, using the specified local
repository directory to resolve ancestor POMs as needed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pomFile</code> - current POM file</dd><dd><code>localRepositoryBasedir</code> - </dd>
<dt><span class="strong">Returns:</span></dt><dd>the Maven project with dependencies from a file and a local repo</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></code> - if any</dd></dl>
</li>
</ul>
<a name="packageProjectArtifact(java.io.File, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>packageProjectArtifact</h4>
<pre>public org.apache.maven.project.MavenProject packageProjectArtifact(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> testVersion,
boolean skipUnitTests)
throws <a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></pre>
<div class="block">Run the plugin's Maven build up to the package phase, in order to produce a jar file for
distribution to a test-time local repository. The testVersion parameter specifies the version
to be used in the <version/> element of the plugin configuration, and also in fully
qualified, unambiguous goal invocations (as in
org.apache.maven.plugins:maven-eclipse-plugin:test:eclipse).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pomFile</code> - The plugin's POM</dd><dd><code>testVersion</code> - The version to use for testing this plugin. To promote test resiliency,
this version should remain unchanged, regardless of what plugin version is under
development.</dd><dd><code>skipUnitTests</code> - In cases where test builds occur during the unit-testing phase (usually
a bad testing smell), the plugin jar must be produced <b>without</b> running unit tests.
Otherwise, the testing process will result in a recursive loop of building a plugin jar and
trying to unit test it during the build. In these cases, set this flag to <code>true</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The resulting MavenProject, after the test version and skip flag (for unit tests)
have been appropriately configured.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></code> - if any</dd></dl>
</li>
</ul>
<a name="packageProjectArtifact(java.io.File, java.lang.String, boolean, java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>packageProjectArtifact</h4>
<pre>public org.apache.maven.project.MavenProject packageProjectArtifact(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> testVersion,
boolean skipUnitTests,
<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> logFile)
throws <a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></pre>
<div class="block">Run the plugin's Maven build up to the package phase, in order to produce a jar file for
distribution to a test-time local repository. The testVersion parameter specifies the version
to be used in the <version/> element of the plugin configuration, and also in fully
qualified, unambiguous goal invocations (as in
org.apache.maven.plugins:maven-eclipse-plugin:test:eclipse).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pomFile</code> - The plugin's POM</dd><dd><code>testVersion</code> - The version to use for testing this plugin. To promote test resiliency,
this version should remain unchanged, regardless of what plugin version is under
development.</dd><dd><code>skipUnitTests</code> - In cases where test builds occur during the unit-testing phase (usually
a bad testing smell), the plugin jar must be produced <b>without</b> running unit tests.
Otherwise, the testing process will result in a recursive loop of building a plugin jar and
trying to unit test it during the build. In these cases, set this flag to <code>true</code>.</dd><dd><code>logFile</code> - The file to which build output should be logged, in order to allow later
inspection in case this build fails.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The resulting MavenProject, after the test version and skip flag (for unit tests)
have been appropriately configured.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></code> - if any</dd></dl>
</li>
</ul>
<a name="manglePomForTesting(java.io.File, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>manglePomForTesting</h4>
<pre>protected org.apache.maven.shared.test.plugin.ProjectTool.PomInfo manglePomForTesting(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a> pomFile,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> testVersion,
boolean skipUnitTests)
throws <a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></pre>
<div class="block">Inject a special version for testing, to allow tests to unambiguously reference the plugin
currently under test. If test builds will be executed from the unit-testing phase, also inject
<skip>true</skip> into the configuration of the <code>maven-surefire-plugin</code>
to allow production of a test-only version of the plugin jar without running unit tests.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pomFile</code> - The plugin POM</dd><dd><code>testVersion</code> - The version that allows test builds to reference the plugin under test</dd><dd><code>skipUnitTests</code> - If true, configure the surefire plugin to skip unit tests</dd>
<dt><span class="strong">Returns:</span></dt><dd>Information about mangled POM, including the temporary file to which it was written.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../org/apache/maven/shared/test/plugin/TestToolsException.html" title="class in org.apache.maven.shared.test.plugin">TestToolsException</a></code> - if any</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProjectTool.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/maven/shared/test/plugin/PluginTestTool.html" title="class in org.apache.maven.shared.test.plugin"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../org/apache/maven/shared/test/plugin/RepositoryTool.html" title="class in org.apache.maven.shared.test.plugin"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/maven/shared/test/plugin/ProjectTool.html" target="_top">Frames</a></li>
<li><a href="ProjectTool.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2008–2014. All rights reserved.</small></p>
</body>
</html>
|