/usr/share/doc/libplexus-build-api-java/api/org/sonatype/plexus/build/incremental/DefaultBuildContext.html is in libplexus-build-api-java-doc 0.0.4-4.
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 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Tue Oct 18 04:29:42 UTC 2011 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
DefaultBuildContext (Unnamed - org.sonatype.plexus:plexus-build-api:jar:0.0.4 0.0.4 API)
</TITLE>
<META NAME="date" CONTENT="2011-10-18">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DefaultBuildContext (Unnamed - org.sonatype.plexus:plexus-build-api:jar:0.0.4 0.0.4 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../org/sonatype/plexus/build/incremental/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DefaultBuildContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/sonatype/plexus/build/incremental/EmptyScanner.html" title="class in org.sonatype.plexus.build.incremental"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/sonatype/plexus/build/incremental/DefaultBuildContext.html" target="_top"><B>FRAMES</B></A>
<A HREF="DefaultBuildContext.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.sonatype.plexus.build.incremental</FONT>
<BR>
Class DefaultBuildContext</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.sonatype.plexus.build.incremental.DefaultBuildContext</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>DefaultBuildContext</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></DL>
</PRE>
<P>
Filesystem based non-incremental build context implementation which behaves as if all files
were just created. More specifically,
hasDelta returns <code>true</code> for all paths
newScanner returns Scanner that scanns all files under provided basedir
newDeletedScanner always returns empty scanner.
isIncremental returns <code>false</code<
getValue always returns <code>null</code>
<P>
<P>
<HR>
<P>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#DefaultBuildContext()">DefaultBuildContext</A></B>()</CODE>
<BR>
</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#getValue(java.lang.String)">getValue</A></B>(java.lang.String key)</CODE>
<BR>
Returns value associated with <code>key</code> during previous mojo execution.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#hasDelta(java.util.List)">hasDelta</A></B>(java.util.List relpaths)</CODE>
<BR>
Returns <code>true</code> if any file or folder identified by <code>relpaths</code> has
changed since last build.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#hasDelta(java.lang.String)">hasDelta</A></B>(java.lang.String relpath)</CODE>
<BR>
Returns <code>true</code> if file or folder identified by <code>relpath</code> has
changed since last build.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#isIncremental()">isIncremental</A></B>()</CODE>
<BR>
Returns <code>true</code> if this build context is incremental.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.codehaus.plexus.util.Scanner</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#newDeleteScanner(java.io.File)">newDeleteScanner</A></B>(java.io.File basedir)</CODE>
<BR>
Returned Scanner scans <code>basedir</code> for files and directories
deleted since last build.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.io.OutputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#newFileOutputStream(java.io.File)">newFileOutputStream</A></B>(java.io.File file)</CODE>
<BR>
Returns new OutputStream that writes to the <code>file</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.codehaus.plexus.util.Scanner</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#newScanner(java.io.File)">newScanner</A></B>(java.io.File basedir)</CODE>
<BR>
Convenience method, fully equal to newScanner(basedir, false)</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> org.codehaus.plexus.util.Scanner</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#newScanner(java.io.File, boolean)">newScanner</A></B>(java.io.File basedir,
boolean ignoreDelta)</CODE>
<BR>
Returned Scanner scans files and folders under <code>basedir</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#refresh(java.io.File)">refresh</A></B>(java.io.File file)</CODE>
<BR>
Indicates that the file or folder content has been modified during the build.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/sonatype/plexus/build/incremental/DefaultBuildContext.html#setValue(java.lang.String, java.lang.Object)">setValue</A></B>(java.lang.String key,
java.lang.Object value)</CODE>
<BR>
Associate specified <code>key</code> with specified <code>value</code>
in the build context.</TD>
</TR>
</TABLE>
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
<P>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="DefaultBuildContext()"><!-- --></A><H3>
DefaultBuildContext</H3>
<PRE>
public <B>DefaultBuildContext</B>()</PRE>
<DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="hasDelta(java.lang.String)"><!-- --></A><H3>
hasDelta</H3>
<PRE>
public boolean <B>hasDelta</B>(java.lang.String relpath)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#hasDelta(java.lang.String)">BuildContext</A></CODE></B></DD>
<DD>Returns <code>true</code> if file or folder identified by <code>relpath</code> has
changed since last build.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#hasDelta(java.lang.String)">hasDelta</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>relpath</CODE> - is path relative to build context basedir</DL>
</DD>
</DL>
<HR>
<A NAME="hasDelta(java.util.List)"><!-- --></A><H3>
hasDelta</H3>
<PRE>
public boolean <B>hasDelta</B>(java.util.List relpaths)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#hasDelta(java.util.List)">BuildContext</A></CODE></B></DD>
<DD>Returns <code>true</code> if any file or folder identified by <code>relpaths</code> has
changed since last build.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#hasDelta(java.util.List)">hasDelta</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>relpaths</CODE> - List<String> are paths relative to build context basedir</DL>
</DD>
</DL>
<HR>
<A NAME="newFileOutputStream(java.io.File)"><!-- --></A><H3>
newFileOutputStream</H3>
<PRE>
public java.io.OutputStream <B>newFileOutputStream</B>(java.io.File file)
throws java.io.IOException</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newFileOutputStream(java.io.File)">BuildContext</A></CODE></B></DD>
<DD>Returns new OutputStream that writes to the <code>file</code>.
Files changed using OutputStream returned by this method do not need to be
explicitly refreshed using <A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#refresh(java.io.File)"><CODE>BuildContext.refresh(File)</CODE></A>.
As an optional optimisation, OutputStreams created by incremental build
context will attempt to avoid writing to the file if file content
has not changed.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newFileOutputStream(java.io.File)">newFileOutputStream</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE></DL>
</DD>
</DL>
<HR>
<A NAME="newScanner(java.io.File)"><!-- --></A><H3>
newScanner</H3>
<PRE>
public org.codehaus.plexus.util.Scanner <B>newScanner</B>(java.io.File basedir)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newScanner(java.io.File)">BuildContext</A></CODE></B></DD>
<DD>Convenience method, fully equal to newScanner(basedir, false)
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newScanner(java.io.File)">newScanner</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="refresh(java.io.File)"><!-- --></A><H3>
refresh</H3>
<PRE>
public void <B>refresh</B>(java.io.File file)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#refresh(java.io.File)">BuildContext</A></CODE></B></DD>
<DD>Indicates that the file or folder content has been modified during the build.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#refresh(java.io.File)">refresh</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newFileOutputStream(java.io.File)"><CODE>BuildContext.newFileOutputStream(File)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="newDeleteScanner(java.io.File)"><!-- --></A><H3>
newDeleteScanner</H3>
<PRE>
public org.codehaus.plexus.util.Scanner <B>newDeleteScanner</B>(java.io.File basedir)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newDeleteScanner(java.io.File)">BuildContext</A></CODE></B></DD>
<DD>Returned Scanner scans <code>basedir</code> for files and directories
deleted since last build. Returns empty Scanner if <code>basedir</code>
is not under this build context basedir.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newDeleteScanner(java.io.File)">newDeleteScanner</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="newScanner(java.io.File, boolean)"><!-- --></A><H3>
newScanner</H3>
<PRE>
public org.codehaus.plexus.util.Scanner <B>newScanner</B>(java.io.File basedir,
boolean ignoreDelta)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newScanner(java.io.File, boolean)">BuildContext</A></CODE></B></DD>
<DD>Returned Scanner scans files and folders under <code>basedir</code>.
If this is an incremental build context and <code>ignoreDelta</code>
is <code>false</code>, the scanner will only "see" files and folders with
content changes since last build.
If <code>ignoreDelta</code> is <code>true</code>, the scanner will "see" all
files and folders.
Returns empty Scanner if <code>basedir</code> is not under this build context basedir.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newScanner(java.io.File, boolean)">newScanner</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="isIncremental()"><!-- --></A><H3>
isIncremental</H3>
<PRE>
public boolean <B>isIncremental</B>()</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#isIncremental()">BuildContext</A></CODE></B></DD>
<DD>Returns <code>true</code> if this build context is incremental.
Scanners created by <A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newScanner(java.io.File)"><CODE>BuildContext.newScanner(File)</CODE></A> of an incremental build context
will ignore files and folders that were not changed since last build.
Additionally, <A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#newDeleteScanner(java.io.File)"><CODE>BuildContext.newDeleteScanner(File)</CODE></A> will scan files and directories
deleted since last build.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#isIncremental()">isIncremental</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="getValue(java.lang.String)"><!-- --></A><H3>
getValue</H3>
<PRE>
public java.lang.Object <B>getValue</B>(java.lang.String key)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#getValue(java.lang.String)">BuildContext</A></CODE></B></DD>
<DD>Returns value associated with <code>key</code> during previous mojo execution.
This method always returns <code>null</code> for non-incremental builds
(i.e., <A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#isIncremental()"><CODE>BuildContext.isIncremental()</CODE></A> returns <code>false</code>) and mojos are
expected to fall back to full, non-incremental behaviour.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#getValue(java.lang.String)">getValue</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#setValue(java.lang.String, java.lang.Object)"><CODE>BuildContext.setValue(String, Object)</CODE></A>,
<A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#isIncremental()"><CODE>BuildContext.isIncremental()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setValue(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setValue</H3>
<PRE>
public void <B>setValue</B>(java.lang.String key,
java.lang.Object value)</PRE>
<DL>
<DD><B>Description copied from interface: <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#setValue(java.lang.String, java.lang.Object)">BuildContext</A></CODE></B></DD>
<DD>Associate specified <code>key</code> with specified <code>value</code>
in the build context.
Primary (and the only) purpose of this method is to allow preservation of
state needed for proper incremental behaviour between consecutive executions
of the same mojo needed to.
For example, maven-plugin-plugin:descriptor mojo
can store collection of extracted MojoDescritpor during first invocation. Then
on each consecutive execution maven-plugin-plugin:descriptor will only need
to extract MojoDescriptors for changed files.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#setValue(java.lang.String, java.lang.Object)">setValue</A></CODE> in interface <CODE><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental">BuildContext</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html#getValue(java.lang.String)"><CODE>BuildContext.getValue(String)</CODE></A></DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../org/sonatype/plexus/build/incremental/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DefaultBuildContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../org/sonatype/plexus/build/incremental/BuildContext.html" title="interface in org.sonatype.plexus.build.incremental"><B>PREV CLASS</B></A>
<A HREF="../../../../../org/sonatype/plexus/build/incremental/EmptyScanner.html" title="class in org.sonatype.plexus.build.incremental"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/sonatype/plexus/build/incremental/DefaultBuildContext.html" target="_top"><B>FRAMES</B></A>
<A HREF="DefaultBuildContext.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright © 2011. All Rights Reserved.
</BODY>
</HTML>
|