You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2012/12/10 23:08:57 UTC
svn commit: r841560 [36/45] - in
/websites/production/maven/content/enforcer: ./ enforcer-rules/
enforcer-rules/apidocs/org/apache/maven/plugins/enforcer/
enforcer-rules/apidocs/org/apache/maven/plugins/enforcer/class-use/
enforcer-rules/apidocs/org/ap...
Added: websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.html
==============================================================================
--- websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.html (added)
+++ websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.html Mon Dec 10 22:08:37 2012
@@ -0,0 +1,136 @@
+<!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>EnforcerRuleHelper xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../../apidocs/org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.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.enforcer.rule.api;
+<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> java.util.List;
+<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.Map;
+<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> org.apache.maven.plugin.logging.Log;
+<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.PlexusContainer;
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.component.configurator.expression.ExpressionEvaluator;
+<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.component.repository.exception.ComponentLookupException;
+<a class="jxr_linenumber" name="29" href="#29">29</a>
+<a class="jxr_linenumber" name="30" href="#30">30</a>
+<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * This is the interface that all helpers will use. This</em>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * provides access to the log, session and components to the</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * rules.</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brianf@apache.org" target="alexandria_uri">mailto:brianf@apache.org</a>">Brian Fox</a></em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @version $Id: EnforcerRuleHelper.java 805162 2009-08-17 21:48:52Z hboutemy $</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleHelper.html">EnforcerRuleHelper</a>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">extends</strong> ExpressionEvaluator
+<a class="jxr_linenumber" name="41" href="#41">41</a> {
+<a class="jxr_linenumber" name="42" href="#42">42</a>
+<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * Gets the log.</em>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @return the log</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> Log getLog ();
+<a class="jxr_linenumber" name="49" href="#49">49</a>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_comment"> * (non-Javadoc)</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_comment"> * @see org.apache.maven.shared.enforcer.rule.api.EnforcerRuleHelper#getRuntimeInformation()</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * Gets the component.</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @param clazz the clazz</em>
+<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> * @return the component</em>
+<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"> * @throws ComponentLookupException the component lookup exception</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> Object getComponent ( Class clazz )
+<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">throws</strong> ComponentLookupException;
+<a class="jxr_linenumber" name="66" href="#66">66</a>
+<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> <em class="jxr_javadoccomment"> * Gets the component.</em>
+<a class="jxr_linenumber" name="69" href="#69">69</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @param componentKey the component key</em>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * @return the component</em>
+<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @throws ComponentLookupException the component lookup exception</em>
+<a class="jxr_linenumber" name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="76" href="#76">76</a> Object getComponent ( String componentKey )
+<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">throws</strong> ComponentLookupException;
+<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"> * Gets the component.</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"> * @param role the role</em>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param roleHint the role hint</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @return the component</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> <em class="jxr_javadoccomment"> * @throws ComponentLookupException the component lookup exception</em>
+<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="89" href="#89">89</a> Object getComponent ( String role, String roleHint )
+<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">throws</strong> ComponentLookupException;
+<a class="jxr_linenumber" name="91" href="#91">91</a>
+<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"> * Gets the component map.</em>
+<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @param role the role</em>
+<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @return the component map</em>
+<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"> * @throws ComponentLookupException the component lookup exception</em>
+<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="101" href="#101">101</a> Map getComponentMap ( String role )
+<a class="jxr_linenumber" name="102" href="#102">102</a> <strong class="jxr_keyword">throws</strong> ComponentLookupException;
+<a class="jxr_linenumber" name="103" href="#103">103</a>
+<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * Gets the component list.</em>
+<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * @param role the role</em>
+<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * @return the component list</em>
+<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * @throws ComponentLookupException the component lookup exception</em>
+<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="113" href="#113">113</a> List getComponentList ( String role )
+<a class="jxr_linenumber" name="114" href="#114">114</a> <strong class="jxr_keyword">throws</strong> ComponentLookupException;
+<a class="jxr_linenumber" name="115" href="#115">115</a>
+<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * Gets the container.</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> <em class="jxr_javadoccomment"> * @return the container</em>
+<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="121" href="#121">121</a> PlexusContainer getContainer();
+<a class="jxr_linenumber" name="122" href="#122">122</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/package-frame.html
==============================================================================
--- websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/package-frame.html (added)
+++ websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/package-frame.html Mon Dec 10 22:08:37 2012
@@ -0,0 +1,30 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>Enforcer 1.2 Reference Package org.apache.maven.enforcer.rule.api</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+
+ <h3>
+ <a href="package-summary.html" target="classFrame">org.apache.maven.enforcer.rule.api</a>
+ </h3>
+
+ <h3>Classes</h3>
+
+ <ul>
+ <li>
+ <a href="EnforcerRule.html" target="classFrame">EnforcerRule</a>
+ </li>
+ <li>
+ <a href="EnforcerRuleException.html" target="classFrame">EnforcerRuleException</a>
+ </li>
+ <li>
+ <a href="EnforcerRuleHelper.html" target="classFrame">EnforcerRuleHelper</a>
+ </li>
+ </ul>
+
+ </body>
+</html>
\ No newline at end of file
Added: websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/package-summary.html
==============================================================================
--- websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/package-summary.html (added)
+++ websites/production/maven/content/enforcer/xref/org/apache/maven/enforcer/rule/api/package-summary.html Mon Dec 10 22:08:37 2012
@@ -0,0 +1,77 @@
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
+<html xml:lang="en" lang="en">
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
+ <title>Enforcer 1.2 Reference Package org.apache.maven.enforcer.rule.api</title>
+ <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="style" />
+ </head>
+ <body>
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+
+ <h2>Package org.apache.maven.enforcer.rule.api</h2>
+
+ <table class="summary">
+ <thead>
+ <tr>
+ <th>Class Summary</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>
+ <a href="EnforcerRule.html" target="classFrame">EnforcerRule</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="EnforcerRuleException.html" target="classFrame">EnforcerRuleException</a>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <a href="EnforcerRuleHelper.html" target="classFrame">EnforcerRuleHelper</a>
+ </td>
+ </tr>
+ </tbody>
+ </table>
+
+ <div class="overview">
+ <ul>
+ <li>
+ <a href="../../../../../../overview-summary.html">Overview</a>
+ </li>
+ <li class="selected">Package</li>
+ </ul>
+ </div>
+ <div class="framenoframe">
+ <ul>
+ <li>
+ <a href="../../../../../../index.html" target="_top">FRAMES</a>
+ </li>
+ <li>
+ <a href="package-summary.html" target="_top">NO FRAMES</a>
+ </li>
+ </ul>
+ </div>
+ <hr />
+ Copyright © 2007-2012 The Apache Software Foundation. All Rights Reserved.
+ </body>
+</html>
\ No newline at end of file
Added: websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractBanDependencies.html
==============================================================================
--- websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractBanDependencies.html (added)
+++ websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractBanDependencies.html Mon Dec 10 22:08:37 2012
@@ -0,0 +1,175 @@
+<!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>AbstractBanDependencies xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/enforcer/AbstractBanDependencies.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.plugins.enforcer;
+<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> java.util.Set;
+<a class="jxr_linenumber" name="23" href="#23">23</a>
+<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.maven.artifact.Artifact;
+<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.maven.enforcer.rule.api.EnforcerRuleException;
+<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.plugin.logging.Log;
+<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.project.MavenProject;
+<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.codehaus.plexus.component.configurator.expression.ExpressionEvaluationException;
+<a class="jxr_linenumber" name="30" href="#30">30</a>
+<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Abstract Rule for banning dependencies.</em>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brianf@apache.org" target="alexandria_uri">mailto:brianf@apache.org</a>">Brian Fox</a></em>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractBanDependencies.java 1345332 2012-06-01 20:14:13Z rfscholte $</em>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractBanDependencies.html">AbstractBanDependencies</a>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.html">AbstractNonCacheableEnforcerRule</a>
+<a class="jxr_linenumber" name="39" href="#39">39</a> {
+<a class="jxr_linenumber" name="40" href="#40">40</a>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Specify if transitive dependencies should be searched (default) or only look at direct dependencies. */</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> searchTransitive = <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="43" href="#43">43</a>
+<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * Execute the rule.</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @param helper the helper</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException the enforcer rule exception</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute( EnforcerRuleHelper helper )
+<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>
+<a class="jxr_linenumber" name="52" href="#52">52</a> {
+<a class="jxr_linenumber" name="53" href="#53">53</a>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_comment">// get the project</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a> MavenProject project = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">try</strong>
+<a class="jxr_linenumber" name="57" href="#57">57</a> {
+<a class="jxr_linenumber" name="58" href="#58">58</a> project = (MavenProject) helper.evaluate( <span class="jxr_string">"${project}"</span> );
+<a class="jxr_linenumber" name="59" href="#59">59</a> }
+<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">catch</strong> ( ExpressionEvaluationException eee )
+<a class="jxr_linenumber" name="61" href="#61">61</a> {
+<a class="jxr_linenumber" name="62" href="#62">62</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>( <span class="jxr_string">"Unable to retrieve the MavenProject: "</span>, eee );
+<a class="jxr_linenumber" name="63" href="#63">63</a> }
+<a class="jxr_linenumber" name="64" href="#64">64</a>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_comment">// get the correct list of dependencies</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a> Set<Artifact> dependencies = getDependenciesToCheck( project );
+<a class="jxr_linenumber" name="67" href="#67">67</a>
+<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_comment">// look for banned dependencies</em>
+<a class="jxr_linenumber" name="69" href="#69">69</a> Set<Artifact> foundExcludes = checkDependencies( dependencies, helper.getLog() );
+<a class="jxr_linenumber" name="70" href="#70">70</a>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_comment">// if any are found, fail the check but list all of them</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">if</strong> ( foundExcludes != <strong class="jxr_keyword">null</strong> && !foundExcludes.isEmpty() )
+<a class="jxr_linenumber" name="73" href="#73">73</a> {
+<a class="jxr_linenumber" name="74" href="#74">74</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
+<a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">if</strong> ( message != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="76" href="#76">76</a> {
+<a class="jxr_linenumber" name="77" href="#77">77</a> buf.append( message + <span class="jxr_string">"\n"</span> );
+<a class="jxr_linenumber" name="78" href="#78">78</a> }
+<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">for</strong> ( Artifact artifact : foundExcludes )
+<a class="jxr_linenumber" name="80" href="#80">80</a> {
+<a class="jxr_linenumber" name="81" href="#81">81</a> buf.append( getErrorMessage( artifact ) );
+<a class="jxr_linenumber" name="82" href="#82">82</a> }
+<a class="jxr_linenumber" name="83" href="#83">83</a> message = buf.toString()+ <span class="jxr_string">"Use 'mvn dependency:tree' to locate the source of the banned dependencies."</span>;
+<a class="jxr_linenumber" name="84" href="#84">84</a>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>( message );
+<a class="jxr_linenumber" name="86" href="#86">86</a> }
+<a class="jxr_linenumber" name="87" href="#87">87</a>
+<a class="jxr_linenumber" name="88" href="#88">88</a> }
+<a class="jxr_linenumber" name="89" href="#89">89</a>
+<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">protected</strong> CharSequence getErrorMessage( Artifact artifact )
+<a class="jxr_linenumber" name="91" href="#91">91</a> {
+<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"Found Banned Dependency: "</span> + artifact.getId() + <span class="jxr_string">"\n"</span>;
+<a class="jxr_linenumber" name="93" href="#93">93</a> }
+<a class="jxr_linenumber" name="94" href="#94">94</a>
+<a class="jxr_linenumber" name="95" href="#95">95</a> @SuppressWarnings( <span class="jxr_string">"unchecked"</span> )
+<a class="jxr_linenumber" name="96" href="#96">96</a> <strong class="jxr_keyword">protected</strong> Set<Artifact> getDependenciesToCheck( MavenProject project )
+<a class="jxr_linenumber" name="97" href="#97">97</a> {
+<a class="jxr_linenumber" name="98" href="#98">98</a> Set<Artifact> dependencies = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> ( searchTransitive )
+<a class="jxr_linenumber" name="100" href="#100">100</a> {
+<a class="jxr_linenumber" name="101" href="#101">101</a> dependencies = project.getArtifacts();
+<a class="jxr_linenumber" name="102" href="#102">102</a> }
+<a class="jxr_linenumber" name="103" href="#103">103</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="104" href="#104">104</a> {
+<a class="jxr_linenumber" name="105" href="#105">105</a> dependencies = project.getDependencyArtifacts();
+<a class="jxr_linenumber" name="106" href="#106">106</a> }
+<a class="jxr_linenumber" name="107" href="#107">107</a> <strong class="jxr_keyword">return</strong> dependencies;
+<a class="jxr_linenumber" name="108" href="#108">108</a> }
+<a class="jxr_linenumber" name="109" href="#109">109</a>
+<a class="jxr_linenumber" name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * Checks the set of dependencies against the list of excludes.</em>
+<a class="jxr_linenumber" name="112" href="#112">112</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * @param dependencies the dependencies</em>
+<a class="jxr_linenumber" name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @param log the log</em>
+<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @return the sets the</em>
+<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException the enforcer rule exception</em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="118" href="#118">118</a> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">protected</strong> Set<Artifact> checkDependencies( Set<Artifact> dependencies, Log log )
+<a class="jxr_linenumber" name="119" href="#119">119</a> <strong class="jxr_keyword">throws</strong> EnforcerRuleException;
+<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"> * Gets the message.</em>
+<a class="jxr_linenumber" name="123" href="#123">123</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * @return the message</em>
+<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="126" href="#126">126</a> <strong class="jxr_keyword">public</strong> String getMessage()
+<a class="jxr_linenumber" name="127" href="#127">127</a> {
+<a class="jxr_linenumber" name="128" href="#128">128</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.message;
+<a class="jxr_linenumber" name="129" href="#129">129</a> }
+<a class="jxr_linenumber" name="130" href="#130">130</a>
+<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * Sets the message.</em>
+<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * @param theMessage the message to set</em>
+<a class="jxr_linenumber" name="135" href="#135">135</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="136" href="#136">136</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setMessage( String theMessage )
+<a class="jxr_linenumber" name="137" href="#137">137</a> {
+<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">this</strong>.message = theMessage;
+<a class="jxr_linenumber" name="139" href="#139">139</a> }
+<a class="jxr_linenumber" name="140" href="#140">140</a>
+<a class="jxr_linenumber" name="141" href="#141">141</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="142" href="#142">142</a> <em class="jxr_javadoccomment"> * Checks if is search transitive.</em>
+<a class="jxr_linenumber" name="143" href="#143">143</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * @return the searchTransitive</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">public</strong> <strong class="jxr_keyword">boolean</strong> isSearchTransitive()
+<a class="jxr_linenumber" name="147" href="#147">147</a> {
+<a class="jxr_linenumber" name="148" href="#148">148</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.searchTransitive;
+<a class="jxr_linenumber" name="149" href="#149">149</a> }
+<a class="jxr_linenumber" name="150" href="#150">150</a>
+<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * Sets the search transitive.</em>
+<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * @param theSearchTransitive the searchTransitive to set</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">public</strong> <strong class="jxr_keyword">void</strong> setSearchTransitive( <strong class="jxr_keyword">boolean</strong> theSearchTransitive )
+<a class="jxr_linenumber" name="157" href="#157">157</a> {
+<a class="jxr_linenumber" name="158" href="#158">158</a> <strong class="jxr_keyword">this</strong>.searchTransitive = theSearchTransitive;
+<a class="jxr_linenumber" name="159" href="#159">159</a> }
+<a class="jxr_linenumber" name="160" href="#160">160</a>
+<a class="jxr_linenumber" name="161" href="#161">161</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.html
==============================================================================
--- websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.html (added)
+++ websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.html Mon Dec 10 22:08:37 2012
@@ -0,0 +1,79 @@
+<!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>AbstractNonCacheableEnforcerRule xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.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.plugins.enforcer;
+<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.enforcer.rule.api.EnforcerRule;
+<a class="jxr_linenumber" name="23" href="#23">23</a>
+<a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * The Class AbstractNonCacheableEnforcerRule. This is to be used by rules</em>
+<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * that don't need caching... it saves implementing a bunch of methods.</em>
+<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brianf@apache.org" target="alexandria_uri">mailto:brianf@apache.org</a>">Brian Fox</a></em>
+<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractNonCacheableEnforcerRule.java 805190 2009-08-17 22:30:49Z hboutemy $</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.html">AbstractNonCacheableEnforcerRule</a>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.html">AbstractStandardEnforcerRule</a>
+<a class="jxr_linenumber" name="33" href="#33">33</a> {
+<a class="jxr_linenumber" name="34" href="#34">34</a>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_comment"> * (non-Javadoc)</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#getCacheId()</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> <strong class="jxr_keyword">public</strong> String getCacheId()
+<a class="jxr_linenumber" name="41" href="#41">41</a> {
+<a class="jxr_linenumber" name="42" href="#42">42</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"0"</span>;
+<a class="jxr_linenumber" name="43" href="#43">43</a> }
+<a class="jxr_linenumber" name="44" href="#44">44</a>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_comment"> * (non-Javadoc)</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isCacheable()</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCacheable()
+<a class="jxr_linenumber" name="51" href="#51">51</a> {
+<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="53" href="#53">53</a> }
+<a class="jxr_linenumber" name="54" href="#54">54</a>
+<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_comment"> * (non-Javadoc)</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#isResultValid(org.apache.maven.enforcer.rule.api.EnforcerRule)</em>
+<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isResultValid( EnforcerRule cachedRule )
+<a class="jxr_linenumber" name="61" href="#61">61</a> {
+<a class="jxr_linenumber" name="62" href="#62">62</a> <strong class="jxr_keyword">return</strong> false;
+<a class="jxr_linenumber" name="63" href="#63">63</a> }
+<a class="jxr_linenumber" name="64" href="#64">64</a>
+<a class="jxr_linenumber" name="65" href="#65">65</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html
==============================================================================
--- websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html (added)
+++ websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html Mon Dec 10 22:08:37 2012
@@ -0,0 +1,116 @@
+<!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>AbstractPropertyEnforcerRule xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.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.plugins.enforcer;
+<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.enforcer.rule.api.EnforcerRuleException;
+<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
+<a class="jxr_linenumber" name="24" href="#24">24</a>
+<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> * Abstract enforcer rule that give a foundation to validate properties from multiple sources.</em>
+<a class="jxr_linenumber" name="27" href="#27">27</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * @author Paul Gier</em>
+<a class="jxr_linenumber" name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * @author <a href='<a href="mailto:marvin" target="alexandria_uri">mailto:marvin</a>[at]marvinformatics[dot]com'>Marvin Froeder</a></em>
+<a class="jxr_linenumber" name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * @version $Id: AbstractPropertyEnforcerRule.java 1382374 2012-09-08 21:47:58Z olamy $</em>
+<a class="jxr_linenumber" name="31" href="#31">31</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html">AbstractPropertyEnforcerRule</a>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractNonCacheableEnforcerRule.html">AbstractNonCacheableEnforcerRule</a>
+<a class="jxr_linenumber" name="34" href="#34">34</a> {
+<a class="jxr_linenumber" name="35" href="#35">35</a>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * Match the property value to a given regular expression. Defaults to <code>null</code> (any value is ok).</em>
+<a class="jxr_linenumber" name="38" href="#38">38</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <strong class="jxr_keyword">public</strong> String regex = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="40" href="#40">40</a>
+<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Specify a warning message if the regular expression is not matched.</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="44" href="#44">44</a> <strong class="jxr_keyword">public</strong> String regexMessage = <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="45" href="#45">45</a>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractPropertyEnforcerRule.html">AbstractPropertyEnforcerRule</a>()
+<a class="jxr_linenumber" name="47" href="#47">47</a> {
+<a class="jxr_linenumber" name="48" href="#48">48</a> <strong class="jxr_keyword">super</strong>();
+<a class="jxr_linenumber" name="49" href="#49">49</a> }
+<a class="jxr_linenumber" name="50" href="#50">50</a>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Execute the rule.</em>
+<a class="jxr_linenumber" name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @param helper the helper</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException the enforcer rule exception</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute( EnforcerRuleHelper helper )
+<a class="jxr_linenumber" name="58" href="#58">58</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>
+<a class="jxr_linenumber" name="59" href="#59">59</a> {
+<a class="jxr_linenumber" name="60" href="#60">60</a> Object propValue = resolveValue( helper );
+<a class="jxr_linenumber" name="61" href="#61">61</a>
+<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_comment">// Check that the property is not null or empty string</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a> <strong class="jxr_keyword">if</strong> ( propValue == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="64" href="#64">64</a> {
+<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">if</strong> ( message == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="66" href="#66">66</a> {
+<a class="jxr_linenumber" name="67" href="#67">67</a> message = getName() + <span class="jxr_string">" \""</span> + getPropertyName() + <span class="jxr_string">"\" is required for this build."</span>;
+<a class="jxr_linenumber" name="68" href="#68">68</a> }
+<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>( message );
+<a class="jxr_linenumber" name="70" href="#70">70</a> }
+<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_comment">// If there is a regex, check that the property matches it</em>
+<a class="jxr_linenumber" name="72" href="#72">72</a> <strong class="jxr_keyword">if</strong> ( regex != <strong class="jxr_keyword">null</strong> && !propValue.toString().matches( regex ) )
+<a class="jxr_linenumber" name="73" href="#73">73</a> {
+<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">if</strong> ( regexMessage == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="75" href="#75">75</a> {
+<a class="jxr_linenumber" name="76" href="#76">76</a> regexMessage = getName() + <span class="jxr_string">" \""</span> + getPropertyName() + <span class="jxr_string">"\" evaluates to \""</span> + propValue + <span class="jxr_string">"\". "</span>
+<a class="jxr_linenumber" name="77" href="#77">77</a> + <span class="jxr_string">"This does not match the regular expression \""</span> + regex + <span class="jxr_string">"\""</span>;
+<a class="jxr_linenumber" name="78" href="#78">78</a> }
+<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>( regexMessage );
+<a class="jxr_linenumber" name="80" href="#80">80</a> }
+<a class="jxr_linenumber" name="81" href="#81">81</a> }
+<a class="jxr_linenumber" name="82" href="#82">82</a>
+<a class="jxr_linenumber" name="83" href="#83">83</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * How the property that is being evaluated is called</em>
+<a class="jxr_linenumber" name="85" href="#85">85</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getName();
+<a class="jxr_linenumber" name="87" href="#87">87</a>
+<a class="jxr_linenumber" name="88" href="#88">88</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_javadoccomment"> * The name of the property currently being evaluated, this is used for default message pourpouses only</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> String getPropertyName();
+<a class="jxr_linenumber" name="92" href="#92">92</a>
+<a class="jxr_linenumber" name="93" href="#93">93</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="94" href="#94">94</a> <em class="jxr_javadoccomment"> * Resolves the property value</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> <em class="jxr_javadoccomment"> * @param helper</em>
+<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @throws EnforcerRuleException</em>
+<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> Object resolveValue( EnforcerRuleHelper helper )
+<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">throws</strong> EnforcerRuleException;
+<a class="jxr_linenumber" name="101" href="#101">101</a>
+<a class="jxr_linenumber" name="102" href="#102">102</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+
Added: websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractRequireFiles.html
==============================================================================
--- websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractRequireFiles.html (added)
+++ websites/production/maven/content/enforcer/xref/org/apache/maven/plugins/enforcer/AbstractRequireFiles.html Mon Dec 10 22:08:37 2012
@@ -0,0 +1,189 @@
+<!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>AbstractRequireFiles xref</title>
+<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
+</head>
+<body>
+<div id="overview"><a href="../../../../../../apidocs/org/apache/maven/plugins/enforcer/AbstractRequireFiles.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.plugins.enforcer;
+<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> java.io.File;
+<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
+<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.List;
+<a class="jxr_linenumber" name="25" href="#25">25</a>
+<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.maven.enforcer.rule.api.EnforcerRule;
+<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.maven.enforcer.rule.api.EnforcerRuleException;
+<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.apache.maven.enforcer.rule.api.EnforcerRuleHelper;
+<a class="jxr_linenumber" name="29" href="#29">29</a>
+<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"> * Contains the common code to compare an array of files against a requirement.</em>
+<a class="jxr_linenumber" name="32" href="#32">32</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:brianf@apache.org" target="alexandria_uri">mailto:brianf@apache.org</a>">Brian Fox</a></em>
+<a class="jxr_linenumber" name="34" href="#34">34</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractRequireFiles.html">AbstractRequireFiles</a>
+<a class="jxr_linenumber" name="36" href="#36">36</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../org/apache/maven/plugins/enforcer/AbstractStandardEnforcerRule.html">AbstractStandardEnforcerRule</a>
+<a class="jxr_linenumber" name="37" href="#37">37</a> {
+<a class="jxr_linenumber" name="38" href="#38">38</a>
+<a class="jxr_linenumber" name="39" href="#39">39</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Array of files to check. */</em>
+<a class="jxr_linenumber" name="40" href="#40">40</a> File[] files;
+<a class="jxr_linenumber" name="41" href="#41">41</a>
+<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> if null file handles should be allowed. If they are allowed, it means treat it as a success. */</em>
+<a class="jxr_linenumber" name="43" href="#43">43</a> <strong class="jxr_keyword">boolean</strong> allowNulls = false;
+<a class="jxr_linenumber" name="44" href="#44">44</a>
+<a class="jxr_linenumber" name="45" href="#45">45</a> <em class="jxr_comment">// check the file for the specific condition</em>
+<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * Check one file.</em>
+<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @param file the file</em>
+<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if successful</em>
+<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="52" href="#52">52</a> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">boolean</strong> checkFile( File file );
+<a class="jxr_linenumber" name="53" href="#53">53</a>
+<a class="jxr_linenumber" name="54" href="#54">54</a> <em class="jxr_comment">// return standard error message</em>
+<a class="jxr_linenumber" name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * Gets the error msg.</em>
+<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * @return the error msg</em>
+<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="60" href="#60">60</a> <strong class="jxr_keyword">abstract</strong> String getErrorMsg();
+<a class="jxr_linenumber" name="61" href="#61">61</a>
+<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_comment">/*</em>
+<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_comment"> * (non-Javadoc)</em>
+<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_comment"> *</em>
+<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_comment"> * @see org.apache.maven.enforcer.rule.api.EnforcerRule#execute(org.apache.maven.enforcer.rule.api.EnforcerRuleHelper)</em>
+<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_comment"> */</em>
+<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> execute( EnforcerRuleHelper helper )
+<a class="jxr_linenumber" name="68" href="#68">68</a> <strong class="jxr_keyword">throws</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>
+<a class="jxr_linenumber" name="69" href="#69">69</a> {
+<a class="jxr_linenumber" name="70" href="#70">70</a>
+<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">if</strong> ( !allowNulls && files.length == 0 )
+<a class="jxr_linenumber" name="72" href="#72">72</a> {
+<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>( <span class="jxr_string">"The file list is empty and Null files are disabled."</span> );
+<a class="jxr_linenumber" name="74" href="#74">74</a> }
+<a class="jxr_linenumber" name="75" href="#75">75</a>
+<a class="jxr_linenumber" name="76" href="#76">76</a> List<File> failures = <strong class="jxr_keyword">new</strong> ArrayList<File>();
+<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">for</strong> ( File file : files )
+<a class="jxr_linenumber" name="78" href="#78">78</a> {
+<a class="jxr_linenumber" name="79" href="#79">79</a> <strong class="jxr_keyword">if</strong> ( !allowNulls && file == <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="80" href="#80">80</a> {
+<a class="jxr_linenumber" name="81" href="#81">81</a> failures.add( file );
+<a class="jxr_linenumber" name="82" href="#82">82</a> }
+<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> ( !checkFile( file ) )
+<a class="jxr_linenumber" name="84" href="#84">84</a> {
+<a class="jxr_linenumber" name="85" href="#85">85</a> failures.add( file );
+<a class="jxr_linenumber" name="86" href="#86">86</a> }
+<a class="jxr_linenumber" name="87" href="#87">87</a> }
+<a class="jxr_linenumber" name="88" href="#88">88</a>
+<a class="jxr_linenumber" name="89" href="#89">89</a> <em class="jxr_comment">// if anything was found, log it with the optional message.</em>
+<a class="jxr_linenumber" name="90" href="#90">90</a> <strong class="jxr_keyword">if</strong> ( !failures.isEmpty() )
+<a class="jxr_linenumber" name="91" href="#91">91</a> {
+<a class="jxr_linenumber" name="92" href="#92">92</a> StringBuilder buf = <strong class="jxr_keyword">new</strong> StringBuilder();
+<a class="jxr_linenumber" name="93" href="#93">93</a> <strong class="jxr_keyword">if</strong> ( message != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="94" href="#94">94</a> {
+<a class="jxr_linenumber" name="95" href="#95">95</a> buf.append( message + <span class="jxr_string">"\n"</span> );
+<a class="jxr_linenumber" name="96" href="#96">96</a> }
+<a class="jxr_linenumber" name="97" href="#97">97</a> buf.append( getErrorMsg() );
+<a class="jxr_linenumber" name="98" href="#98">98</a>
+<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">for</strong> ( File file : failures )
+<a class="jxr_linenumber" name="100" href="#100">100</a> {
+<a class="jxr_linenumber" name="101" href="#101">101</a> <strong class="jxr_keyword">if</strong> ( file != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="102" href="#102">102</a> {
+<a class="jxr_linenumber" name="103" href="#103">103</a> buf.append( file.getAbsolutePath() + <span class="jxr_string">"\n"</span> );
+<a class="jxr_linenumber" name="104" href="#104">104</a> }
+<a class="jxr_linenumber" name="105" href="#105">105</a> <strong class="jxr_keyword">else</strong>
+<a class="jxr_linenumber" name="106" href="#106">106</a> {
+<a class="jxr_linenumber" name="107" href="#107">107</a> buf.append( <span class="jxr_string">"(an empty filename was given and allowNulls is false)\n"</span> );
+<a class="jxr_linenumber" name="108" href="#108">108</a> }
+<a class="jxr_linenumber" name="109" href="#109">109</a> }
+<a class="jxr_linenumber" name="110" href="#110">110</a>
+<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/maven/enforcer/rule/api/EnforcerRuleException.html">EnforcerRuleException</a>( buf.toString() );
+<a class="jxr_linenumber" name="112" href="#112">112</a> }
+<a class="jxr_linenumber" name="113" href="#113">113</a> }
+<a class="jxr_linenumber" name="114" href="#114">114</a>
+<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"> * If your rule is cacheable, you must return a unique id when parameters or conditions change that would cause the</em>
+<a class="jxr_linenumber" name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * result to be different. Multiple cached results are stored based on their id. The easiest way to do this is to</em>
+<a class="jxr_linenumber" name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * return a hash computed from the values of your parameters. If your rule is not cacheable, then the result here is</em>
+<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> * not important, you may return anything.</em>
+<a class="jxr_linenumber" name="120" href="#120">120</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @return the cache id</em>
+<a class="jxr_linenumber" name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="123" href="#123">123</a> <strong class="jxr_keyword">public</strong> String getCacheId()
+<a class="jxr_linenumber" name="124" href="#124">124</a> {
+<a class="jxr_linenumber" name="125" href="#125">125</a> <strong class="jxr_keyword">return</strong> Integer.toString( hashCode( files ) );
+<a class="jxr_linenumber" name="126" href="#126">126</a> }
+<a class="jxr_linenumber" name="127" href="#127">127</a>
+<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * Calculates a hash code for the specified array as <code>Arrays.hashCode()</code> would do. Unfortunately, the</em>
+<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * mentioned method is only available for Java 1.5 and later.</em>
+<a class="jxr_linenumber" name="131" href="#131">131</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @param items The array for which to compute the hash code, may be <code>null</code>.</em>
+<a class="jxr_linenumber" name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * @return The hash code for the array.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">int</strong> hashCode( Object[] items )
+<a class="jxr_linenumber" name="136" href="#136">136</a> {
+<a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">int</strong> hash = 0;
+<a class="jxr_linenumber" name="138" href="#138">138</a> <strong class="jxr_keyword">if</strong> ( items != <strong class="jxr_keyword">null</strong> )
+<a class="jxr_linenumber" name="139" href="#139">139</a> {
+<a class="jxr_linenumber" name="140" href="#140">140</a> hash = 1;
+<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">for</strong> ( <strong class="jxr_keyword">int</strong> i = 0; i < items.length; i++ )
+<a class="jxr_linenumber" name="142" href="#142">142</a> {
+<a class="jxr_linenumber" name="143" href="#143">143</a> Object item = items[i];
+<a class="jxr_linenumber" name="144" href="#144">144</a> hash = 31 * hash + ( item == <strong class="jxr_keyword">null</strong> ? 0 : item.hashCode() );
+<a class="jxr_linenumber" name="145" href="#145">145</a> }
+<a class="jxr_linenumber" name="146" href="#146">146</a> }
+<a class="jxr_linenumber" name="147" href="#147">147</a> <strong class="jxr_keyword">return</strong> hash;
+<a class="jxr_linenumber" name="148" href="#148">148</a> }
+<a class="jxr_linenumber" name="149" href="#149">149</a>
+<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment"> * This tells the system if the results are cacheable at all. Keep in mind that during forked builds and other</em>
+<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * things, a given rule may be executed more than once for the same project. This means that even things that change</em>
+<a class="jxr_linenumber" name="153" href="#153">153</a> <em class="jxr_javadoccomment"> * from project to project may still be cacheable in certain instances.</em>
+<a class="jxr_linenumber" name="154" href="#154">154</a> <em class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if rule is cacheable</em>
+<a class="jxr_linenumber" name="156" href="#156">156</a> <em class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="157" href="#157">157</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isCacheable()
+<a class="jxr_linenumber" name="158" href="#158">158</a> {
+<a class="jxr_linenumber" name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="160" href="#160">160</a> }
+<a class="jxr_linenumber" name="161" href="#161">161</a>
+<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment"> * If the rule is cacheable and the same id is found in the cache, the stored results are passed to this method to</em>
+<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * allow double checking of the results. Most of the time this can be done by generating unique ids, but sometimes</em>
+<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * the results of objects returned by the helper need to be queried. You may for example, store certain objects in</em>
+<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * your rule and then query them later.</em>
+<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"> * @param cachedRule the cached rule</em>
+<a class="jxr_linenumber" name="169" href="#169">169</a> <em class="jxr_javadoccomment"> * @return <code>true</code> if the stored results are valid for the same id.</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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isResultValid( EnforcerRule cachedRule )
+<a class="jxr_linenumber" name="172" href="#172">172</a> {
+<a class="jxr_linenumber" name="173" href="#173">173</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
+<a class="jxr_linenumber" name="174" href="#174">174</a> }
+<a class="jxr_linenumber" name="175" href="#175">175</a> }
+</pre>
+<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
+</html>
+