Modified: websites/production/maven/content/plugins-archives/maven-clean-plugin-LATEST/xref/org/apache/maven/plugin/clean/CleanMojo.html ============================================================================== --- websites/production/maven/content/plugins-archives/maven-clean-plugin-LATEST/xref/org/apache/maven/plugin/clean/CleanMojo.html (original) +++ websites/production/maven/content/plugins-archives/maven-clean-plugin-LATEST/xref/org/apache/maven/plugin/clean/CleanMojo.html Mon Sep 22 06:49:35 2014 @@ -1,261 +1,248 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> -<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>CleanMojo xref</title> -<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> -</head> -<body> -<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/clean/CleanMojo.html">View Javadoc</a></div><pre> - -<a class="jxr_linenumber" name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.clean; -<a class="jxr_linenumber" name="2" href="#2">2</a> -<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment">/*</em> -<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a class="jxr_linenumber" name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0"; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> -<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> *</em> -<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a class="jxr_linenumber" name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a class="jxr_linenumber" name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a class="jxr_linenumber" name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em> -<a class="jxr_linenumber" name="20" href="#20">20</a> <em class="jxr_comment"> */</em> -<a class="jxr_linenumber" name="21" href="#21">21</a> -<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; -<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; -<a class="jxr_linenumber" name="24" href="#24">24</a> -<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.File; -<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.io.IOException; -<a class="jxr_linenumber" name="27" href="#27">27</a> -<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * Goal which cleans the build.</em> -<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * <P>This attempts to clean a project's working directory of the files that</em> -<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * were generated at build-time. By default, it discovers and deletes the</em> -<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * directories configured in <code>project.build.directory</code>,</em> -<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * <code>project.build.outputDirectory</code>,</em> -<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * <code>project.build.testOutputDirectory</code>, and</em> -<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <code>project.reporting.outputDirectory</code>. </P></em> -<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * <P>Files outside the default may also be included in the deletion by</em> -<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * configuring the <code>filesets</code> tag.</P></em> -<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:eveni...@maven.org"; target="alexandria_uri">mailto:eveni...@maven.org</a>">Emmanuel Venisse</a></em> -<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @version $Id: CleanMojo.java 1026638 2010-10-23 16:30:17Z bentmann $</em> -<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @goal clean</em> -<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @threadSafe</em> -<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @since 2.0</em> -<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.clean.Fileset</em> -<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/clean/CleanMojo.html">CleanMojo</a> -<a class="jxr_linenumber" name="49" href="#49">49</a> <strong class="jxr_keyword">extends</strong> AbstractMojo -<a class="jxr_linenumber" name="50" href="#50">50</a> { -<a class="jxr_linenumber" name="51" href="#51">51</a> -<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * This is where build results go.</em> -<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @parameter default-value="${project.build.directory}"</em> -<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @required</em> -<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="59" href="#59">59</a> <strong class="jxr_keyword">private</strong> File directory; -<a class="jxr_linenumber" name="60" href="#60">60</a> -<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * This is where compiled classes go.</em> -<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * @parameter default-value="${project.build.outputDirectory}"</em> -<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * @required</em> -<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">private</strong> File outputDirectory; -<a class="jxr_linenumber" name="69" href="#69">69</a> -<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * This is where compiled test classes go.</em> -<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @parameter default-value="${project.build.testOutputDirectory}"</em> -<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @required</em> -<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> File testOutputDirectory; -<a class="jxr_linenumber" name="78" href="#78">78</a> -<a class="jxr_linenumber" name="79" href="#79">79</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * This is where the site plugin generates its pages.</em> -<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @parameter default-value="${project.reporting.outputDirectory}"</em> -<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @required</em> -<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * @readonly</em> -<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @since 2.1.1</em> -<a class="jxr_linenumber" name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">private</strong> File reportDirectory; -<a class="jxr_linenumber" name="88" href="#88">88</a> -<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Sets whether the plugin runs in verbose mode. As of plugin version 2.3, the default value is derived from Maven's</em> -<a class="jxr_linenumber" name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * global debug flag (compare command line switch <code>-X</code>).</em> -<a class="jxr_linenumber" name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * @parameter expression="${clean.verbose}"</em> -<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">private</strong> Boolean verbose; -<a class="jxr_linenumber" name="97" href="#97">97</a> -<a class="jxr_linenumber" name="98" href="#98">98</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="99" href="#99">99</a> <em class="jxr_javadoccomment"> * The list of file sets to delete, in addition to the default directories. For example:</em> -<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * <pre></em> -<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * &lt;filesets&gt;</em> -<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * &lt;fileset&gt;</em> -<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * &lt;directory&gt;src/main/generated&lt;/directory&gt;</em> -<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * &lt;followSymlinks&gt;false&lt;/followSymlinks&gt;</em> -<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * &lt;useDefaultExcludes&gt;true&lt;/useDefaultExcludes&gt;</em> -<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * &lt;includes&gt;</em> -<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * &lt;include&gt;*.java&lt;/include&gt;</em> -<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * &lt;/includes&gt;</em> -<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * &lt;excludes&gt;</em> -<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> * &lt;exclude&gt;Template*&lt;/exclude&gt;</em> -<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * &lt;/excludes&gt;</em> -<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> * &lt;/fileset&gt;</em> -<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * &lt;/filesets&gt;</em> -<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * </pre></em> -<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * @parameter</em> -<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="119" href="#119">119</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/maven/plugin/clean/Fileset.html">Fileset</a>[] filesets; -<a class="jxr_linenumber" name="120" href="#120">120</a> -<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> * Sets whether the plugin should follow symbolic links while deleting files from the default output directories of</em> -<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> * the project. Not following symlinks requires more IO operations and heap memory, regardless whether symlinks are</em> -<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * actually present. So projects with a huge output directory that knowingly does not contain symlinks can improve</em> -<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * performance by setting this parameter to <code>true</code>.</em> -<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * @parameter expression="${clean.followSymLinks}" default-value="false"</em> -<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @since 2.1</em> -<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="130" href="#130">130</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> followSymLinks; -<a class="jxr_linenumber" name="131" href="#131">131</a> -<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * Disables the plugin execution.</em> -<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @parameter expression="${clean.skip}" default-value="false"</em> -<a class="jxr_linenumber" name="136" href="#136">136</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="137" href="#137">137</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; -<a class="jxr_linenumber" name="139" href="#139">139</a> -<a class="jxr_linenumber" name="140" href="#140">140</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * Indicates whether the build will continue even if there are clean errors.</em> -<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> *</em> -<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * @parameter expression="${maven.clean.failOnError}" default-value="true"</em> -<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @since 2.2</em> -<a class="jxr_linenumber" name="145" href="#145">145</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="146" href="#146">146</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failOnError; -<a class="jxr_linenumber" name="147" href="#147">147</a> -<a class="jxr_linenumber" name="148" href="#148">148</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * Indicates whether the plugin should undertake additional attempts (after a short delay) to delete a file if the</em> -<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * first attempt failed. This is meant to help deleting files that are temporarily locked by third-party tools like</em> -<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * virus scanners or search indexing.</em> -<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * @parameter expression="${maven.clean.retryOnError}" default-value="true"</em> -<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * @since 2.4.2</em> -<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="156" href="#156">156</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> retryOnError; -<a class="jxr_linenumber" name="157" href="#157">157</a> -<a class="jxr_linenumber" name="158" href="#158">158</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment"> * Disables the deletion of the default output directories configured for a project. If set to <code>true</code>,</em> -<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * only the files/directories selected via the parameter {@link #filesets} will be deleted.</em> -<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * @parameter expression="${clean.excludeDefaultDirectories}" default-value="false"</em> -<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * @since 2.3</em> -<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="165" href="#165">165</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> excludeDefaultDirectories; -<a class="jxr_linenumber" name="166" href="#166">166</a> -<a class="jxr_linenumber" name="167" href="#167">167</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="168" href="#168">168</a> <em class="jxr_javadoccomment"> * Deletes file-sets in the following project build directory order: (source) directory, output directory, test</em> -<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * directory, report directory, and then the additional file-sets.</em> -<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="171" href="#171">171</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em> -<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException When a directory failed to get deleted.</em> -<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="174" href="#174">174</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() -<a class="jxr_linenumber" name="175" href="#175">175</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException -<a class="jxr_linenumber" name="176" href="#176">176</a> { -<a class="jxr_linenumber" name="177" href="#177">177</a> <strong class="jxr_keyword">if</strong> ( skip ) -<a class="jxr_linenumber" name="178" href="#178">178</a> { -<a class="jxr_linenumber" name="179" href="#179">179</a> getLog().info( <span class="jxr_string">"Clean is skipped."</span> ); -<a class="jxr_linenumber" name="180" href="#180">180</a> <strong class="jxr_keyword">return</strong>; -<a class="jxr_linenumber" name="181" href="#181">181</a> } -<a class="jxr_linenumber" name="182" href="#182">182</a> -<a class="jxr_linenumber" name="183" href="#183">183</a> <a href="../../../../../org/apache/maven/plugin/clean/Cleaner.html">Cleaner</a> cleaner = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/clean/Cleaner.html">Cleaner</a>( getLog(), isVerbose() ); -<a class="jxr_linenumber" name="184" href="#184">184</a> -<a class="jxr_linenumber" name="185" href="#185">185</a> <strong class="jxr_keyword">try</strong> -<a class="jxr_linenumber" name="186" href="#186">186</a> { -<a class="jxr_linenumber" name="187" href="#187">187</a> File[] directories = getDirectories(); -<a class="jxr_linenumber" name="188" href="#188">188</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i < directories.length; i++ ) -<a class="jxr_linenumber" name="189" href="#189">189</a> { -<a class="jxr_linenumber" name="190" href="#190">190</a> File directory = directories[i]; -<a class="jxr_linenumber" name="191" href="#191">191</a> <strong class="jxr_keyword">if</strong> ( directory != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="192" href="#192">192</a> { -<a class="jxr_linenumber" name="193" href="#193">193</a> cleaner.delete( directory, <strong class="jxr_keyword">null</strong>, followSymLinks, failOnError, retryOnError ); -<a class="jxr_linenumber" name="194" href="#194">194</a> } -<a class="jxr_linenumber" name="195" href="#195">195</a> } -<a class="jxr_linenumber" name="196" href="#196">196</a> -<a class="jxr_linenumber" name="197" href="#197">197</a> <strong class="jxr_keyword">if</strong> ( filesets != <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="198" href="#198">198</a> { -<a class="jxr_linenumber" name="199" href="#199">199</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i < filesets.length; i++ ) -<a class="jxr_linenumber" name="200" href="#200">200</a> { -<a class="jxr_linenumber" name="201" href="#201">201</a> <a href="../../../../../org/apache/maven/plugin/clean/Fileset.html">Fileset</a> fileset = filesets[i]; -<a class="jxr_linenumber" name="202" href="#202">202</a> <strong class="jxr_keyword">if</strong> ( fileset.getDirectory() == <strong class="jxr_keyword">null</strong> ) -<a class="jxr_linenumber" name="203" href="#203">203</a> { -<a class="jxr_linenumber" name="204" href="#204">204</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Missing base directory for "</span> + fileset ); -<a class="jxr_linenumber" name="205" href="#205">205</a> } -<a class="jxr_linenumber" name="206" href="#206">206</a> <a href="../../../../../org/apache/maven/plugin/clean/GlobSelector.html">GlobSelector</a> selector = -<a class="jxr_linenumber" name="207" href="#207">207</a> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/clean/GlobSelector.html">GlobSelector</a>( fileset.getIncludes(), fileset.getExcludes(), fileset.isUseDefaultExcludes() ); -<a class="jxr_linenumber" name="208" href="#208">208</a> cleaner.delete( fileset.getDirectory(), selector, fileset.isFollowSymlinks(), failOnError, -<a class="jxr_linenumber" name="209" href="#209">209</a> retryOnError ); -<a class="jxr_linenumber" name="210" href="#210">210</a> } -<a class="jxr_linenumber" name="211" href="#211">211</a> } -<a class="jxr_linenumber" name="212" href="#212">212</a> } -<a class="jxr_linenumber" name="213" href="#213">213</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) -<a class="jxr_linenumber" name="214" href="#214">214</a> { -<a class="jxr_linenumber" name="215" href="#215">215</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Failed to clean project: "</span> + e.getMessage(), e ); -<a class="jxr_linenumber" name="216" href="#216">216</a> } -<a class="jxr_linenumber" name="217" href="#217">217</a> } -<a class="jxr_linenumber" name="218" href="#218">218</a> -<a class="jxr_linenumber" name="219" href="#219">219</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * Indicates whether verbose output is enabled.</em> -<a class="jxr_linenumber" name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if verbose output is enabled, <code>false</code> otherwise.</em> -<a class="jxr_linenumber" name="223" href="#223">223</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="224" href="#224">224</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isVerbose() -<a class="jxr_linenumber" name="225" href="#225">225</a> { -<a class="jxr_linenumber" name="226" href="#226">226</a> <strong class="jxr_keyword">return</strong> ( verbose != <strong class="jxr_keyword">null</strong> ) ? verbose.booleanValue() : getLog().isDebugEnabled(); -<a class="jxr_linenumber" name="227" href="#227">227</a> } -<a class="jxr_linenumber" name="228" href="#228">228</a> -<a class="jxr_linenumber" name="229" href="#229">229</a> <em class="jxr_javadoccomment">/**</em> -<a class="jxr_linenumber" name="230" href="#230">230</a> <em class="jxr_javadoccomment"> * Gets the directories to clean (if any). The returned array may contain null entries.</em> -<a class="jxr_linenumber" name="231" href="#231">231</a> <em class="jxr_javadoccomment"> * </em> -<a class="jxr_linenumber" name="232" href="#232">232</a> <em class="jxr_javadoccomment"> * @return The directories to clean or an empty array if none, never <code>null</code>.</em> -<a class="jxr_linenumber" name="233" href="#233">233</a> <em class="jxr_javadoccomment"> */</em> -<a class="jxr_linenumber" name="234" href="#234">234</a> <strong class="jxr_keyword">private</strong> File[] getDirectories() -<a class="jxr_linenumber" name="235" href="#235">235</a> { -<a class="jxr_linenumber" name="236" href="#236">236</a> File[] directories; -<a class="jxr_linenumber" name="237" href="#237">237</a> <strong class="jxr_keyword">if</strong> ( excludeDefaultDirectories ) -<a class="jxr_linenumber" name="238" href="#238">238</a> { -<a class="jxr_linenumber" name="239" href="#239">239</a> directories = <strong class="jxr_keyword">new</strong> File[0]; -<a class="jxr_linenumber" name="240" href="#240">240</a> } -<a class="jxr_linenumber" name="241" href="#241">241</a> <strong class="jxr_keyword">else</strong> -<a class="jxr_linenumber" name="242" href="#242">242</a> { -<a class="jxr_linenumber" name="243" href="#243">243</a> directories = <strong class="jxr_keyword">new</strong> File[] { directory, outputDirectory, testOutputDirectory, reportDirectory }; -<a class="jxr_linenumber" name="244" href="#244">244</a> } -<a class="jxr_linenumber" name="245" href="#245">245</a> <strong class="jxr_keyword">return</strong> directories; -<a class="jxr_linenumber" name="246" href="#246">246</a> } -<a class="jxr_linenumber" name="247" href="#247">247</a> -<a class="jxr_linenumber" name="248" href="#248">248</a> } -</pre> -<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> -</html> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";> +<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>CleanMojo xref</title> +<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> +</head> +<body> +<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugin/clean/CleanMojo.html">View Javadoc</a></div><pre> +<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.maven.plugin.clean; +<a class="jxr_linenumber" name="L2" href="#L2">2</a> +<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2."; target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</em> +<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.AbstractMojo; +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.MojoExecutionException; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Mojo; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugins.annotations.Parameter; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.io.File; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.io.IOException; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Goal which cleans the build.</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * <P>This attempts to clean a project's working directory of the files that</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * were generated at build-time. By default, it discovers and deletes the</em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * directories configured in <code>project.build.directory</code>,</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * <code>project.build.outputDirectory</code>,</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> * <code>project.build.testOutputDirectory</code>, and</em> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <code>project.reporting.outputDirectory</code>. </P></em> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * <p/></em> +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <P>Files outside the default may also be included in the deletion by</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * configuring the <code>filesets</code> tag.</P></em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:eveni...@maven.org"; target="alexandria_uri">mailto:eveni...@maven.org</a>">Emmanuel Venisse</a></em> +<a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @version $Id: CleanMojo.java 1517354 2013-08-25 18:02:43Z krosenvold $</em> +<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.clean.Fileset</em> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @since 2.0</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> @Mojo( name = <span class="jxr_string">"clean"</span>, threadSafe = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugin/clean/CleanMojo.html">CleanMojo</a> +<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">extends</strong> AbstractMojo +<a class="jxr_linenumber" name="L51" href="#L51">51</a> { +<a class="jxr_linenumber" name="L52" href="#L52">52</a> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> * This is where build results go.</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L56" href="#L56">56</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.directory}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <strong class="jxr_keyword">private</strong> File directory; +<a class="jxr_linenumber" name="L58" href="#L58">58</a> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> * This is where compiled classes go.</em> +<a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.outputDirectory}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">private</strong> File outputDirectory; +<a class="jxr_linenumber" name="L64" href="#L64">64</a> +<a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * This is where compiled test classes go.</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.testOutputDirectory}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">private</strong> File testOutputDirectory; +<a class="jxr_linenumber" name="L70" href="#L70">70</a> +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * This is where the site plugin generates its pages.</em> +<a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> * @since 2.1.1</em> +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L76" href="#L76">76</a> @Parameter( defaultValue = <span class="jxr_string">"${project.build.outputDirectory}"</span>, readonly = <strong class="jxr_keyword">true</strong>, required = <strong class="jxr_keyword">true</strong> ) +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">private</strong> File reportDirectory; +<a class="jxr_linenumber" name="L78" href="#L78">78</a> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L80" href="#L80">80</a> <em class="jxr_javadoccomment"> * Sets whether the plugin runs in verbose mode. As of plugin version 2.3, the default value is derived from Maven's</em> +<a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment"> * global debug flag (compare command line switch <code>-X</code>).</em> +<a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L85" href="#L85">85</a> @Parameter( property = <span class="jxr_string">"clean.verbose"</span> ) +<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">private</strong> Boolean verbose; +<a class="jxr_linenumber" name="L87" href="#L87">87</a> +<a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * The list of file sets to delete, in addition to the default directories. For example:</em> +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> * <pre></em> +<a class="jxr_linenumber" name="L91" href="#L91">91</a> <em class="jxr_javadoccomment"> * &lt;filesets&gt;</em> +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_javadoccomment"> * &lt;fileset&gt;</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment"> * &lt;directory&gt;src/main/generated&lt;/directory&gt;</em> +<a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * &lt;followSymlinks&gt;false&lt;/followSymlinks&gt;</em> +<a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * &lt;useDefaultExcludes&gt;true&lt;/useDefaultExcludes&gt;</em> +<a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * &lt;includes&gt;</em> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * &lt;include&gt;*.java&lt;/include&gt;</em> +<a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> * &lt;/includes&gt;</em> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * &lt;excludes&gt;</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * &lt;exclude&gt;Template*&lt;/exclude&gt;</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * &lt;/excludes&gt;</em> +<a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> * &lt;/fileset&gt;</em> +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_javadoccomment"> * &lt;/filesets&gt;</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> <em class="jxr_javadoccomment"> * </pre></em> +<a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L108" href="#L108">108</a> @Parameter +<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">private</strong> <a href="../../../../../org/apache/maven/plugin/clean/Fileset.html">Fileset</a>[] filesets; +<a class="jxr_linenumber" name="L110" href="#L110">110</a> +<a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * Sets whether the plugin should follow symbolic links while deleting files from the default output directories of</em> +<a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * the project. Not following symlinks requires more IO operations and heap memory, regardless whether symlinks are</em> +<a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> * actually present. So projects with a huge output directory that knowingly does not contain symlinks can improve</em> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_javadoccomment"> * performance by setting this parameter to <code>true</code>.</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L117" href="#L117">117</a> <em class="jxr_javadoccomment"> * @since 2.1</em> +<a class="jxr_linenumber" name="L118" href="#L118">118</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> @Parameter( property = <span class="jxr_string">"clean.followSymLinks"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> followSymLinks; +<a class="jxr_linenumber" name="L121" href="#L121">121</a> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L123" href="#L123">123</a> <em class="jxr_javadoccomment"> * Disables the plugin execution.</em> +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L125" href="#L125">125</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L126" href="#L126">126</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> @Parameter( property = <span class="jxr_string">"clean.skip"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> skip; +<a class="jxr_linenumber" name="L129" href="#L129">129</a> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * Indicates whether the build will continue even if there are clean errors.</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> * @since 2.2</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L135" href="#L135">135</a> @Parameter( property = <span class="jxr_string">"maven.clean.failOnError"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> failOnError; +<a class="jxr_linenumber" name="L137" href="#L137">137</a> +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em class="jxr_javadoccomment"> * Indicates whether the plugin should undertake additional attempts (after a short delay) to delete a file if the</em> +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <em class="jxr_javadoccomment"> * first attempt failed. This is meant to help deleting files that are temporarily locked by third-party tools like</em> +<a class="jxr_linenumber" name="L141" href="#L141">141</a> <em class="jxr_javadoccomment"> * virus scanners or search indexing.</em> +<a class="jxr_linenumber" name="L142" href="#L142">142</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment"> * @since 2.4.2</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> @Parameter( property = <span class="jxr_string">"maven.clean.retryOnError"</span>, defaultValue = <span class="jxr_string">"true"</span> ) +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> retryOnError; +<a class="jxr_linenumber" name="L147" href="#L147">147</a> +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em class="jxr_javadoccomment"> * Disables the deletion of the default output directories configured for a project. If set to <code>true</code>,</em> +<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em class="jxr_javadoccomment"> * only the files/directories selected via the parameter {@link #filesets} will be deleted.</em> +<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment"> * @since 2.3</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> @Parameter( property = <span class="jxr_string">"clean.excludeDefaultDirectories"</span>, defaultValue = <span class="jxr_string">"false"</span> ) +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> excludeDefaultDirectories; +<a class="jxr_linenumber" name="L156" href="#L156">156</a> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment"> * Deletes file-sets in the following project build directory order: (source) directory, output directory, test</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * directory, report directory, and then the additional file-sets.</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em class="jxr_javadoccomment"> * @throws MojoExecutionException When a directory failed to get deleted.</em> +<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em class="jxr_javadoccomment"> * @see org.apache.maven.plugin.Mojo#execute()</em> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute() +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong class="jxr_keyword">throws</strong> MojoExecutionException +<a class="jxr_linenumber" name="L166" href="#L166">166</a> { +<a class="jxr_linenumber" name="L167" href="#L167">167</a> <strong class="jxr_keyword">if</strong> ( skip ) +<a class="jxr_linenumber" name="L168" href="#L168">168</a> { +<a class="jxr_linenumber" name="L169" href="#L169">169</a> getLog().info( <span class="jxr_string">"Clean is skipped."</span> ); +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">return</strong>; +<a class="jxr_linenumber" name="L171" href="#L171">171</a> } +<a class="jxr_linenumber" name="L172" href="#L172">172</a> +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <a href="../../../../../org/apache/maven/plugin/clean/Cleaner.html">Cleaner</a> cleaner = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/clean/Cleaner.html">Cleaner</a>( getLog(), isVerbose() ); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L176" href="#L176">176</a> { +<a class="jxr_linenumber" name="L177" href="#L177">177</a> <strong class="jxr_keyword">for</strong> ( File directory : getDirectories() ) +<a class="jxr_linenumber" name="L178" href="#L178">178</a> { +<a class="jxr_linenumber" name="L179" href="#L179">179</a> <strong class="jxr_keyword">if</strong> ( directory != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L180" href="#L180">180</a> { +<a class="jxr_linenumber" name="L181" href="#L181">181</a> cleaner.delete( directory, <strong class="jxr_keyword">null</strong>, followSymLinks, failOnError, retryOnError ); +<a class="jxr_linenumber" name="L182" href="#L182">182</a> } +<a class="jxr_linenumber" name="L183" href="#L183">183</a> } +<a class="jxr_linenumber" name="L184" href="#L184">184</a> +<a class="jxr_linenumber" name="L185" href="#L185">185</a> <strong class="jxr_keyword">if</strong> ( filesets != <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L186" href="#L186">186</a> { +<a class="jxr_linenumber" name="L187" href="#L187">187</a> <strong class="jxr_keyword">for</strong> ( Fileset fileset : filesets ) +<a class="jxr_linenumber" name="L188" href="#L188">188</a> { +<a class="jxr_linenumber" name="L189" href="#L189">189</a> <strong class="jxr_keyword">if</strong> ( fileset.getDirectory() == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L190" href="#L190">190</a> { +<a class="jxr_linenumber" name="L191" href="#L191">191</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Missing base directory for "</span> + fileset ); +<a class="jxr_linenumber" name="L192" href="#L192">192</a> } +<a class="jxr_linenumber" name="L193" href="#L193">193</a> <a href="../../../../../org/apache/maven/plugin/clean/GlobSelector.html">GlobSelector</a> selector = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/plugin/clean/GlobSelector.html">GlobSelector</a>( fileset.getIncludes(), fileset.getExcludes(), +<a class="jxr_linenumber" name="L194" href="#L194">194</a> fileset.isUseDefaultExcludes() ); +<a class="jxr_linenumber" name="L195" href="#L195">195</a> cleaner.delete( fileset.getDirectory(), selector, fileset.isFollowSymlinks(), failOnError, +<a class="jxr_linenumber" name="L196" href="#L196">196</a> retryOnError ); +<a class="jxr_linenumber" name="L197" href="#L197">197</a> } +<a class="jxr_linenumber" name="L198" href="#L198">198</a> } +<a class="jxr_linenumber" name="L199" href="#L199">199</a> } +<a class="jxr_linenumber" name="L200" href="#L200">200</a> <strong class="jxr_keyword">catch</strong> ( IOException e ) +<a class="jxr_linenumber" name="L201" href="#L201">201</a> { +<a class="jxr_linenumber" name="L202" href="#L202">202</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> MojoExecutionException( <span class="jxr_string">"Failed to clean project: "</span> + e.getMessage(), e ); +<a class="jxr_linenumber" name="L203" href="#L203">203</a> } +<a class="jxr_linenumber" name="L204" href="#L204">204</a> } +<a class="jxr_linenumber" name="L205" href="#L205">205</a> +<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em class="jxr_javadoccomment"> * Indicates whether verbose output is enabled.</em> +<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if verbose output is enabled, <code>false</code> otherwise.</em> +<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L211" href="#L211">211</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isVerbose() +<a class="jxr_linenumber" name="L212" href="#L212">212</a> { +<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong class="jxr_keyword">return</strong> ( verbose != <strong class="jxr_keyword">null</strong> ) ? verbose : getLog().isDebugEnabled(); +<a class="jxr_linenumber" name="L214" href="#L214">214</a> } +<a class="jxr_linenumber" name="L215" href="#L215">215</a> +<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em class="jxr_javadoccomment"> * Gets the directories to clean (if any). The returned array may contain null entries.</em> +<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em class="jxr_javadoccomment"> * @return The directories to clean or an empty array if none, never <code>null</code>.</em> +<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L221" href="#L221">221</a> <strong class="jxr_keyword">private</strong> File[] getDirectories() +<a class="jxr_linenumber" name="L222" href="#L222">222</a> { +<a class="jxr_linenumber" name="L223" href="#L223">223</a> File[] directories; +<a class="jxr_linenumber" name="L224" href="#L224">224</a> <strong class="jxr_keyword">if</strong> ( excludeDefaultDirectories ) +<a class="jxr_linenumber" name="L225" href="#L225">225</a> { +<a class="jxr_linenumber" name="L226" href="#L226">226</a> directories = <strong class="jxr_keyword">new</strong> File[0]; +<a class="jxr_linenumber" name="L227" href="#L227">227</a> } +<a class="jxr_linenumber" name="L228" href="#L228">228</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L229" href="#L229">229</a> { +<a class="jxr_linenumber" name="L230" href="#L230">230</a> directories = <strong class="jxr_keyword">new</strong> File[]{ directory, outputDirectory, testOutputDirectory, reportDirectory }; +<a class="jxr_linenumber" name="L231" href="#L231">231</a> } +<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong class="jxr_keyword">return</strong> directories; +<a class="jxr_linenumber" name="L233" href="#L233">233</a> } +<a class="jxr_linenumber" name="L234" href="#L234">234</a> +<a class="jxr_linenumber" name="L235" href="#L235">235</a> } +</pre> +<hr/> +<div id="footer">Copyright © 2001–2014 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
