blob: aaf51b2c51c56fb55bbd84e38f3d27dc4d3c0de2 [file] [log] [blame]
<!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>ResolverUtil xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../apidocs/org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*<em class="jxr_comment"> Copyright 2005-2006 Tim Fennell</em></em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License");</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * you may not use this file except in compliance with the License.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="7" href="#7">7</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="8" href="#8">8</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="10" href="#10">10</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j.core.config.plugins;
<a class="jxr_linenumber" name="16" href="#16">16</a>
<a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.Logger;
<a class="jxr_linenumber" name="18" href="#18">18</a> <strong class="jxr_keyword">import</strong> org.apache.logging.log4j.status.StatusLogger;
<a class="jxr_linenumber" name="19" href="#19">19</a>
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.io.File;
<a class="jxr_linenumber" name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> java.io.FileInputStream;
<a class="jxr_linenumber" name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a class="jxr_linenumber" name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.lang.annotation.Annotation;
<a class="jxr_linenumber" name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.net.URI;
<a class="jxr_linenumber" name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.net.URL;
<a class="jxr_linenumber" name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.net.URLDecoder;
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Enumeration;
<a class="jxr_linenumber" name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.HashSet;
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> java.util.jar.JarEntry;
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> java.util.jar.JarInputStream;
<a class="jxr_linenumber" name="32" href="#32">32</a>
<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"> * &lt;p&gt;ResolverUtil is used to locate classes that are available in the/a class path and meet</em>
<a class="jxr_linenumber" name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * arbitrary conditions. The two most common conditions are that a class implements/extends</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * another class, or that is it annotated with a specific annotation. However, through the use</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * of the {@link Test} class it is possible to search using arbitrary conditions.&lt;/p&gt;</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> <em class="jxr_javadoccomment"> * &lt;p&gt;A ClassLoader is used to locate all locations (directories and jar files) in the class</em>
<a class="jxr_linenumber" name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * path that contain classes within certain packages, and then to load those classes and</em>
<a class="jxr_linenumber" name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * check them. By default the ClassLoader returned by</em>
<a class="jxr_linenumber" name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * {@code Thread.currentThread().getContextClassLoader()} is used, but this can be overridden</em>
<a class="jxr_linenumber" name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * by calling {@link #setClassLoader(ClassLoader)} prior to invoking any of the {@code find()}</em>
<a class="jxr_linenumber" name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * methods.&lt;/p&gt;</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"> * &lt;p&gt;General searches are initiated by calling the</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * {@link #find(org.apache.logging.log4j.core..util.ResolverUtil.Test, String...)} ()} method and supplying</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * a package name and a Test instance. This will cause the named package &lt;b&gt;and all sub-packages&lt;/b&gt;</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * to be scanned for classes that meet the test. There are also utility methods for the common</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * use cases of scanning multiple packages for extensions of particular classes, or classes</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * annotated with a specific annotation.&lt;/p&gt;</em>
<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"> * &lt;p&gt;The standard usage pattern for the ResolverUtil class is as follows:&lt;/p&gt;</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"> *&lt;pre&gt;</em>
<a class="jxr_linenumber" name="56" href="#56">56</a> <em class="jxr_javadoccomment"> *ResolverUtil&amp;lt;ActionBean&amp;gt; resolver = new ResolverUtil&amp;lt;ActionBean&amp;gt;();</em>
<a class="jxr_linenumber" name="57" href="#57">57</a> <em class="jxr_javadoccomment"> *resolver.findImplementation(ActionBean.class, pkg1, pkg2);</em>
<a class="jxr_linenumber" name="58" href="#58">58</a> <em class="jxr_javadoccomment"> *resolver.find(new CustomTest(), pkg1);</em>
<a class="jxr_linenumber" name="59" href="#59">59</a> <em class="jxr_javadoccomment"> *resolver.find(new CustomTest(), pkg2);</em>
<a class="jxr_linenumber" name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *Collection&amp;lt;ActionBean&amp;gt; beans = resolver.getClasses();</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> *&lt;/pre&gt;</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * &lt;p&gt;This class was copied from Stripes - <a href="http://stripes.mc4j.org/confluence/display/stripes/Home" target="alexandria_uri">http://stripes.mc4j.org/confluence/display/stripes/Home</a></em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @author Tim Fennell</em>
<a class="jxr_linenumber" name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * @param &lt;T&gt; The type of the Class that can be returned.</em>
<a class="jxr_linenumber" name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> ResolverUtil&lt;T&gt; {
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> An instance of Log to use for logging in this class. */</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger LOG = StatusLogger.getLogger();
<a class="jxr_linenumber" name="72" href="#72">72</a>
<a class="jxr_linenumber" name="73" href="#73">73</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The set of matches being accumulated. */</em>
<a class="jxr_linenumber" name="74" href="#74">74</a> <strong class="jxr_keyword">private</strong> Set&lt;Class&lt;? <strong class="jxr_keyword">extends</strong> T&gt;&gt; classMatches = <strong class="jxr_keyword">new</strong> HashSet&lt;Class&lt;?<strong class="jxr_keyword">extends</strong> T&gt;&gt;();
<a class="jxr_linenumber" name="75" href="#75">75</a>
<a class="jxr_linenumber" name="76" href="#76">76</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The set of matches being accumulated. */</em>
<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> Set&lt;URI&gt; resourceMatches = <strong class="jxr_keyword">new</strong> HashSet&lt;URI&gt;();
<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"> * The ClassLoader to use when looking for classes. If null then the ClassLoader returned</em>
<a class="jxr_linenumber" name="81" href="#81">81</a> <em class="jxr_javadoccomment"> * by Thread.currentThread().getContextClassLoader() will be used.</em>
<a class="jxr_linenumber" name="82" href="#82">82</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="83" href="#83">83</a> <strong class="jxr_keyword">private</strong> ClassLoader classloader;
<a class="jxr_linenumber" name="84" href="#84">84</a>
<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> <em class="jxr_javadoccomment"> * Provides access to the classes discovered so far. If no calls have been made to</em>
<a class="jxr_linenumber" name="87" href="#87">87</a> <em class="jxr_javadoccomment"> * any of the {@code find()} methods, this set will be empty.</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> <em class="jxr_javadoccomment"> * @return the set of classes that have been discovered.</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> Set&lt;Class&lt;? <strong class="jxr_keyword">extends</strong> T&gt;&gt; getClasses() {
<a class="jxr_linenumber" name="92" href="#92">92</a> <strong class="jxr_keyword">return</strong> classMatches;
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * Return the matching resources.</em>
<a class="jxr_linenumber" name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @return A Set of URIs that match the criteria.</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> Set&lt;URI&gt; getResources() {
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">return</strong> resourceMatches;
<a class="jxr_linenumber" name="101" href="#101">101</a> }
<a class="jxr_linenumber" name="102" href="#102">102</a>
<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"> * Returns the classloader that will be used for scanning for classes. If no explicit</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * ClassLoader has been set by the calling, the context class loader will be used.</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @return the ClassLoader that will be used to scan for classes</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="110" href="#110">110</a> <strong class="jxr_keyword">public</strong> ClassLoader getClassLoader() {
<a class="jxr_linenumber" name="111" href="#111">111</a> <strong class="jxr_keyword">return</strong> classloader == <strong class="jxr_keyword">null</strong> ? Thread.currentThread().getContextClassLoader() : classloader;
<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> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * Sets an explicit ClassLoader that should be used when scanning for classes. If none</em>
<a class="jxr_linenumber" name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * is set then the context classloader will be used.</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> <em class="jxr_javadoccomment"> * @param classloader a ClassLoader to use when scanning for classes</em>
<a class="jxr_linenumber" name="119" href="#119">119</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="120" href="#120">120</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setClassLoader(ClassLoader classloader) { <strong class="jxr_keyword">this</strong>.classloader = classloader; }
<a class="jxr_linenumber" name="121" href="#121">121</a>
<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> <em class="jxr_javadoccomment"> * Attempts to discover classes that are assignable to the type provided. In the case</em>
<a class="jxr_linenumber" name="124" href="#124">124</a> <em class="jxr_javadoccomment"> * that an interface is provided this method will collect implementations. In the case</em>
<a class="jxr_linenumber" name="125" href="#125">125</a> <em class="jxr_javadoccomment"> * of a non-interface class, subclasses will be collected. Accumulated classes can be</em>
<a class="jxr_linenumber" name="126" href="#126">126</a> <em class="jxr_javadoccomment"> * accessed by calling {@link #getClasses()}.</em>
<a class="jxr_linenumber" name="127" href="#127">127</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="128" href="#128">128</a> <em class="jxr_javadoccomment"> * @param parent the class of interface to find subclasses or implementations of</em>
<a class="jxr_linenumber" name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @param packageNames one or more package names to scan (including subpackages) for classes</em>
<a class="jxr_linenumber" name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="131" href="#131">131</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> findImplementations(Class parent, String... packageNames) {
<a class="jxr_linenumber" name="132" href="#132">132</a> <strong class="jxr_keyword">if</strong> (packageNames == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="133" href="#133">133</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="134" href="#134">134</a> }
<a class="jxr_linenumber" name="135" href="#135">135</a>
<a class="jxr_linenumber" name="136" href="#136">136</a> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">IsA</a>(parent);
<a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">for</strong> (String pkg : packageNames) {
<a class="jxr_linenumber" name="138" href="#138">138</a> findInPackage(test, pkg);
<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>
<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"> * Attempts to discover classes who's name ends with the provided suffix. Accumulated classes can be</em>
<a class="jxr_linenumber" name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * accessed by calling {@link #getClasses()}.</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> <em class="jxr_javadoccomment"> * @param suffix The class name suffix to match</em>
<a class="jxr_linenumber" name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * @param packageNames one or more package names to scan (including subpackages) for classes</em>
<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> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> findSuffix(String suffix, String... packageNames) {
<a class="jxr_linenumber" name="150" href="#150">150</a> <strong class="jxr_keyword">if</strong> (packageNames == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="152" href="#152">152</a> }
<a class="jxr_linenumber" name="153" href="#153">153</a>
<a class="jxr_linenumber" name="154" href="#154">154</a> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">NameEndsWith</a>(suffix);
<a class="jxr_linenumber" name="155" href="#155">155</a> <strong class="jxr_keyword">for</strong> (String pkg : packageNames) {
<a class="jxr_linenumber" name="156" href="#156">156</a> findInPackage(test, pkg);
<a class="jxr_linenumber" name="157" href="#157">157</a> }
<a class="jxr_linenumber" name="158" href="#158">158</a> }
<a class="jxr_linenumber" name="159" href="#159">159</a>
<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment"> * Attempts to discover classes that are annotated with to the annotation. Accumulated</em>
<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment"> * classes can be accessed by calling {@link #getClasses()}.</em>
<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="164" href="#164">164</a> <em class="jxr_javadoccomment"> * @param annotation the annotation that should be present on matching classes</em>
<a class="jxr_linenumber" name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * @param packageNames one or more package names to scan (including subpackages) for classes</em>
<a class="jxr_linenumber" name="166" href="#166">166</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="167" href="#167">167</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> findAnnotated(Class&lt;? <strong class="jxr_keyword">extends</strong> Annotation&gt; annotation, String... packageNames) {
<a class="jxr_linenumber" name="168" href="#168">168</a> <strong class="jxr_keyword">if</strong> (packageNames == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="169" href="#169">169</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="170" href="#170">170</a> }
<a class="jxr_linenumber" name="171" href="#171">171</a>
<a class="jxr_linenumber" name="172" href="#172">172</a> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">AnnotatedWith</a>(annotation);
<a class="jxr_linenumber" name="173" href="#173">173</a> <strong class="jxr_keyword">for</strong> (String pkg : packageNames) {
<a class="jxr_linenumber" name="174" href="#174">174</a> findInPackage(test, pkg);
<a class="jxr_linenumber" name="175" href="#175">175</a> }
<a class="jxr_linenumber" name="176" href="#176">176</a> }
<a class="jxr_linenumber" name="177" href="#177">177</a>
<a class="jxr_linenumber" name="178" href="#178">178</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> findNamedResource(String name, String... pathNames) {
<a class="jxr_linenumber" name="179" href="#179">179</a> <strong class="jxr_keyword">if</strong> (pathNames == <strong class="jxr_keyword">null</strong>) {
<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/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test = <strong class="jxr_keyword">new</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">NameIs</a>(name);
<a class="jxr_linenumber" name="184" href="#184">184</a> <strong class="jxr_keyword">for</strong> (String pkg : pathNames) {
<a class="jxr_linenumber" name="185" href="#185">185</a> findInPackage(test, pkg);
<a class="jxr_linenumber" name="186" href="#186">186</a> }
<a class="jxr_linenumber" name="187" href="#187">187</a> }
<a class="jxr_linenumber" name="188" href="#188">188</a>
<a class="jxr_linenumber" name="189" href="#189">189</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="190" href="#190">190</a> <em class="jxr_javadoccomment"> * Attempts to discover classes that pass the test. Accumulated</em>
<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment"> * classes can be accessed by calling {@link #getClasses()}.</em>
<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment"> * @param test the test to determine matching classes</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment"> * @param packageNames one or more package names to scan (including subpackages) for classes</em>
<a class="jxr_linenumber" name="195" href="#195">195</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="196" href="#196">196</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> find(<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test, String... packageNames) {
<a class="jxr_linenumber" name="197" href="#197">197</a> <strong class="jxr_keyword">if</strong> (packageNames == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="198" href="#198">198</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="199" href="#199">199</a> }
<a class="jxr_linenumber" name="200" href="#200">200</a>
<a class="jxr_linenumber" name="201" href="#201">201</a> <strong class="jxr_keyword">for</strong> (String pkg : packageNames) {
<a class="jxr_linenumber" name="202" href="#202">202</a> findInPackage(test, pkg);
<a class="jxr_linenumber" name="203" href="#203">203</a> }
<a class="jxr_linenumber" name="204" href="#204">204</a> }
<a class="jxr_linenumber" name="205" href="#205">205</a>
<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment"> * Scans for classes starting at the package provided and descending into subpackages.</em>
<a class="jxr_linenumber" name="208" href="#208">208</a> <em class="jxr_javadoccomment"> * Each class is offered up to the Test as it is discovered, and if the Test returns</em>
<a class="jxr_linenumber" name="209" href="#209">209</a> <em class="jxr_javadoccomment"> * true the class is retained. Accumulated classes can be fetched by calling</em>
<a class="jxr_linenumber" name="210" href="#210">210</a> <em class="jxr_javadoccomment"> * {@link #getClasses()}.</em>
<a class="jxr_linenumber" name="211" href="#211">211</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="212" href="#212">212</a> <em class="jxr_javadoccomment"> * @param test an instance of {@link Test} that will be used to filter classes</em>
<a class="jxr_linenumber" name="213" href="#213">213</a> <em class="jxr_javadoccomment"> * @param packageName the name of the package from which to start scanning for</em>
<a class="jxr_linenumber" name="214" href="#214">214</a> <em class="jxr_javadoccomment"> * classes, e.g. {@code net.sourceforge.stripes}</em>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> findInPackage(<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test, String packageName) {
<a class="jxr_linenumber" name="217" href="#217">217</a> packageName = packageName.replace('.', '/');
<a class="jxr_linenumber" name="218" href="#218">218</a> ClassLoader loader = getClassLoader();
<a class="jxr_linenumber" name="219" href="#219">219</a> Enumeration&lt;URL&gt; urls;
<a class="jxr_linenumber" name="220" href="#220">220</a>
<a class="jxr_linenumber" name="221" href="#221">221</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="222" href="#222">222</a> urls = loader.getResources(packageName);
<a class="jxr_linenumber" name="223" href="#223">223</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a class="jxr_linenumber" name="224" href="#224">224</a> LOG.warn(<span class="jxr_string">"Could not read package: "</span> + packageName, ioe);
<a class="jxr_linenumber" name="225" href="#225">225</a> <strong class="jxr_keyword">return</strong>;
<a class="jxr_linenumber" name="226" href="#226">226</a> }
<a class="jxr_linenumber" name="227" href="#227">227</a>
<a class="jxr_linenumber" name="228" href="#228">228</a> <strong class="jxr_keyword">while</strong> (urls.hasMoreElements()) {
<a class="jxr_linenumber" name="229" href="#229">229</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="230" href="#230">230</a> String urlPath = urls.nextElement().getFile();
<a class="jxr_linenumber" name="231" href="#231">231</a> urlPath = URLDecoder.decode(urlPath, <span class="jxr_string">"UTF-8"</span>);
<a class="jxr_linenumber" name="232" href="#232">232</a>
<a class="jxr_linenumber" name="233" href="#233">233</a> <em class="jxr_comment">// If it's a file in a directory, trim the stupid file: spec</em>
<a class="jxr_linenumber" name="234" href="#234">234</a> <strong class="jxr_keyword">if</strong> (urlPath.startsWith(<span class="jxr_string">"file:"</span>)) {
<a class="jxr_linenumber" name="235" href="#235">235</a> urlPath = urlPath.substring(5);
<a class="jxr_linenumber" name="236" href="#236">236</a> }
<a class="jxr_linenumber" name="237" href="#237">237</a>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_comment">// Else it's in a JAR, grab the path to the jar</em>
<a class="jxr_linenumber" name="239" href="#239">239</a> <strong class="jxr_keyword">if</strong> (urlPath.indexOf('!') &gt; 0) {
<a class="jxr_linenumber" name="240" href="#240">240</a> urlPath = urlPath.substring(0, urlPath.indexOf('!'));
<a class="jxr_linenumber" name="241" href="#241">241</a> }
<a class="jxr_linenumber" name="242" href="#242">242</a>
<a class="jxr_linenumber" name="243" href="#243">243</a> LOG.info(<span class="jxr_string">"Scanning for classes in ["</span> + urlPath + <span class="jxr_string">"] matching criteria: "</span> + test);
<a class="jxr_linenumber" name="244" href="#244">244</a> File file = <strong class="jxr_keyword">new</strong> File(urlPath);
<a class="jxr_linenumber" name="245" href="#245">245</a> <strong class="jxr_keyword">if</strong> (file.isDirectory()) {
<a class="jxr_linenumber" name="246" href="#246">246</a> loadImplementationsInDirectory(test, packageName, file);
<a class="jxr_linenumber" name="247" href="#247">247</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="248" href="#248">248</a> loadImplementationsInJar(test, packageName, file);
<a class="jxr_linenumber" name="249" href="#249">249</a> }
<a class="jxr_linenumber" name="250" href="#250">250</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a class="jxr_linenumber" name="251" href="#251">251</a> LOG.warn(<span class="jxr_string">"could not read entries"</span>, ioe);
<a class="jxr_linenumber" name="252" href="#252">252</a> }
<a class="jxr_linenumber" name="253" href="#253">253</a> }
<a class="jxr_linenumber" name="254" href="#254">254</a> }
<a class="jxr_linenumber" name="255" href="#255">255</a>
<a class="jxr_linenumber" name="256" href="#256">256</a>
<a class="jxr_linenumber" name="257" href="#257">257</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * Finds matches in a physical directory on a filesystem. Examines all</em>
<a class="jxr_linenumber" name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * files within a directory - if the File object is not a directory, and ends with &lt;i&gt;.class&lt;/i&gt;</em>
<a class="jxr_linenumber" name="260" href="#260">260</a> <em class="jxr_javadoccomment"> * the file is loaded and tested to see if it is acceptable according to the Test. Operates</em>
<a class="jxr_linenumber" name="261" href="#261">261</a> <em class="jxr_javadoccomment"> * recursively to find classes within a folder structure matching the package structure.</em>
<a class="jxr_linenumber" name="262" href="#262">262</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="263" href="#263">263</a> <em class="jxr_javadoccomment"> * @param test a Test used to filter the classes that are discovered</em>
<a class="jxr_linenumber" name="264" href="#264">264</a> <em class="jxr_javadoccomment"> * @param parent the package name up to this directory in the package hierarchy. E.g. if</em>
<a class="jxr_linenumber" name="265" href="#265">265</a> <em class="jxr_javadoccomment"> * /classes is in the classpath and we wish to examine files in /classes/org/apache then</em>
<a class="jxr_linenumber" name="266" href="#266">266</a> <em class="jxr_javadoccomment"> * the values of &lt;i&gt;parent&lt;/i&gt; would be &lt;i&gt;org/apache&lt;/i&gt;</em>
<a class="jxr_linenumber" name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * @param location a File object representing a directory</em>
<a class="jxr_linenumber" name="268" href="#268">268</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="269" href="#269">269</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> loadImplementationsInDirectory(<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test, String parent, File location) {
<a class="jxr_linenumber" name="270" href="#270">270</a> File[] files = location.listFiles();
<a class="jxr_linenumber" name="271" href="#271">271</a> StringBuilder builder;
<a class="jxr_linenumber" name="272" href="#272">272</a>
<a class="jxr_linenumber" name="273" href="#273">273</a> <strong class="jxr_keyword">for</strong> (File file : files) {
<a class="jxr_linenumber" name="274" href="#274">274</a> builder = <strong class="jxr_keyword">new</strong> StringBuilder();
<a class="jxr_linenumber" name="275" href="#275">275</a> builder.append(parent).append(<span class="jxr_string">"/"</span>).append(file.getName());
<a class="jxr_linenumber" name="276" href="#276">276</a> String packageOrClass = parent == <strong class="jxr_keyword">null</strong> ? file.getName() : builder.toString();
<a class="jxr_linenumber" name="277" href="#277">277</a>
<a class="jxr_linenumber" name="278" href="#278">278</a> <strong class="jxr_keyword">if</strong> (file.isDirectory()) {
<a class="jxr_linenumber" name="279" href="#279">279</a> loadImplementationsInDirectory(test, packageOrClass, file);
<a class="jxr_linenumber" name="280" href="#280">280</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (isTestApplicable(test, file.getName())) {
<a class="jxr_linenumber" name="281" href="#281">281</a> addIfMatching(test, packageOrClass);
<a class="jxr_linenumber" name="282" href="#282">282</a> }
<a class="jxr_linenumber" name="283" href="#283">283</a> }
<a class="jxr_linenumber" name="284" href="#284">284</a> }
<a class="jxr_linenumber" name="285" href="#285">285</a>
<a class="jxr_linenumber" name="286" href="#286">286</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">boolean</strong> isTestApplicable(<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test, String path) {
<a class="jxr_linenumber" name="287" href="#287">287</a> <strong class="jxr_keyword">return</strong> test.doesMatchResource() || path.endsWith(<span class="jxr_string">".class"</span>) &amp;&amp; test.doesMatchClass();
<a class="jxr_linenumber" name="288" href="#288">288</a> }
<a class="jxr_linenumber" name="289" href="#289">289</a>
<a class="jxr_linenumber" name="290" href="#290">290</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="291" href="#291">291</a> <em class="jxr_javadoccomment"> * Finds matching classes within a jar files that contains a folder structure</em>
<a class="jxr_linenumber" name="292" href="#292">292</a> <em class="jxr_javadoccomment"> * matching the package structure. If the File is not a JarFile or does not exist a warning</em>
<a class="jxr_linenumber" name="293" href="#293">293</a> <em class="jxr_javadoccomment"> * will be logged, but no error will be raised.</em>
<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * @param test a Test used to filter the classes that are discovered</em>
<a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment"> * @param parent the parent package under which classes must be in order to be considered</em>
<a class="jxr_linenumber" name="297" href="#297">297</a> <em class="jxr_javadoccomment"> * @param jarfile the jar file to be examined for classes</em>
<a class="jxr_linenumber" name="298" href="#298">298</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="299" href="#299">299</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> loadImplementationsInJar(<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test, String parent, File jarfile) {
<a class="jxr_linenumber" name="300" href="#300">300</a>
<a class="jxr_linenumber" name="301" href="#301">301</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="302" href="#302">302</a> JarEntry entry;
<a class="jxr_linenumber" name="303" href="#303">303</a> JarInputStream jarStream = <strong class="jxr_keyword">new</strong> JarInputStream(<strong class="jxr_keyword">new</strong> FileInputStream(jarfile));
<a class="jxr_linenumber" name="304" href="#304">304</a>
<a class="jxr_linenumber" name="305" href="#305">305</a> <strong class="jxr_keyword">while</strong> ((entry = jarStream.getNextJarEntry()) != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="306" href="#306">306</a> String name = entry.getName();
<a class="jxr_linenumber" name="307" href="#307">307</a> <strong class="jxr_keyword">if</strong> (!entry.isDirectory() &amp;&amp; name.startsWith(parent) &amp;&amp; isTestApplicable(test, name)) {
<a class="jxr_linenumber" name="308" href="#308">308</a> addIfMatching(test, name);
<a class="jxr_linenumber" name="309" href="#309">309</a> }
<a class="jxr_linenumber" name="310" href="#310">310</a> }
<a class="jxr_linenumber" name="311" href="#311">311</a> } <strong class="jxr_keyword">catch</strong> (IOException ioe) {
<a class="jxr_linenumber" name="312" href="#312">312</a> LOG.error(<span class="jxr_string">"Could not search jar file '"</span> + jarfile + <span class="jxr_string">"' for classes matching criteria: "</span> +
<a class="jxr_linenumber" name="313" href="#313">313</a> test + <span class="jxr_string">" due to an IOException"</span>, ioe);
<a class="jxr_linenumber" name="314" href="#314">314</a> }
<a class="jxr_linenumber" name="315" href="#315">315</a> }
<a class="jxr_linenumber" name="316" href="#316">316</a>
<a class="jxr_linenumber" name="317" href="#317">317</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="318" href="#318">318</a> <em class="jxr_javadoccomment"> * Add the class designated by the fully qualified class name provided to the set of</em>
<a class="jxr_linenumber" name="319" href="#319">319</a> <em class="jxr_javadoccomment"> * resolved classes if and only if it is approved by the Test supplied.</em>
<a class="jxr_linenumber" name="320" href="#320">320</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="321" href="#321">321</a> <em class="jxr_javadoccomment"> * @param test the test used to determine if the class matches</em>
<a class="jxr_linenumber" name="322" href="#322">322</a> <em class="jxr_javadoccomment"> * @param fqn the fully qualified name of a class</em>
<a class="jxr_linenumber" name="323" href="#323">323</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="324" href="#324">324</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> addIfMatching(<a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> test, String fqn) {
<a class="jxr_linenumber" name="325" href="#325">325</a> <strong class="jxr_keyword">try</strong> {
<a class="jxr_linenumber" name="326" href="#326">326</a> ClassLoader loader = getClassLoader();
<a class="jxr_linenumber" name="327" href="#327">327</a> <strong class="jxr_keyword">if</strong> (test.doesMatchClass()) {
<a class="jxr_linenumber" name="328" href="#328">328</a> String externalName = fqn.substring(0, fqn.indexOf('.')).replace('/', '.');
<a class="jxr_linenumber" name="329" href="#329">329</a> <strong class="jxr_keyword">if</strong> (LOG.isDebugEnabled()) {
<a class="jxr_linenumber" name="330" href="#330">330</a> LOG.debug(<span class="jxr_string">"Checking to see if class "</span> + externalName + <span class="jxr_string">" matches criteria ["</span> + test + <span class="jxr_string">"]"</span>);
<a class="jxr_linenumber" name="331" href="#331">331</a> }
<a class="jxr_linenumber" name="332" href="#332">332</a>
<a class="jxr_linenumber" name="333" href="#333">333</a> Class type = loader.loadClass(externalName);
<a class="jxr_linenumber" name="334" href="#334">334</a> <strong class="jxr_keyword">if</strong> (test.matches(type)) {
<a class="jxr_linenumber" name="335" href="#335">335</a> classMatches.add((Class&lt;T&gt;) type);
<a class="jxr_linenumber" name="336" href="#336">336</a> }
<a class="jxr_linenumber" name="337" href="#337">337</a> }
<a class="jxr_linenumber" name="338" href="#338">338</a> <strong class="jxr_keyword">if</strong> (test.doesMatchResource()) {
<a class="jxr_linenumber" name="339" href="#339">339</a> URL url = loader.getResource(fqn);
<a class="jxr_linenumber" name="340" href="#340">340</a> <strong class="jxr_keyword">if</strong> (url == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="341" href="#341">341</a> url = loader.getResource(fqn.substring(1));
<a class="jxr_linenumber" name="342" href="#342">342</a> }
<a class="jxr_linenumber" name="343" href="#343">343</a> <strong class="jxr_keyword">if</strong> (url != <strong class="jxr_keyword">null</strong> &amp;&amp; test.matches(url.toURI())) {
<a class="jxr_linenumber" name="344" href="#344">344</a> resourceMatches.add(url.toURI());
<a class="jxr_linenumber" name="345" href="#345">345</a> }
<a class="jxr_linenumber" name="346" href="#346">346</a> }
<a class="jxr_linenumber" name="347" href="#347">347</a> } <strong class="jxr_keyword">catch</strong> (Throwable t) {
<a class="jxr_linenumber" name="348" href="#348">348</a> LOG.warn(<span class="jxr_string">"Could not examine class '"</span> + fqn + <span class="jxr_string">"' due to a "</span> +
<a class="jxr_linenumber" name="349" href="#349">349</a> t.getClass().getName() + <span class="jxr_string">" with message: "</span> + t.getMessage());
<a class="jxr_linenumber" name="350" href="#350">350</a> }
<a class="jxr_linenumber" name="351" href="#351">351</a> }
<a class="jxr_linenumber" name="352" href="#352">352</a>
<a class="jxr_linenumber" name="353" href="#353">353</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="354" href="#354">354</a> <em class="jxr_javadoccomment"> * A simple interface that specifies how to test classes to determine if they</em>
<a class="jxr_linenumber" name="355" href="#355">355</a> <em class="jxr_javadoccomment"> * are to be included in the results produced by the ResolverUtil.</em>
<a class="jxr_linenumber" name="356" href="#356">356</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="357" href="#357">357</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> {
<a class="jxr_linenumber" name="358" href="#358">358</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="359" href="#359">359</a> <em class="jxr_javadoccomment"> * Will be called repeatedly with candidate classes. Must return True if a class</em>
<a class="jxr_linenumber" name="360" href="#360">360</a> <em class="jxr_javadoccomment"> * is to be included in the results, false otherwise.</em>
<a class="jxr_linenumber" name="361" href="#361">361</a> <em class="jxr_javadoccomment"> * @param type The Class to match against.</em>
<a class="jxr_linenumber" name="362" href="#362">362</a> <em class="jxr_javadoccomment"> * @return true if the Class matches.</em>
<a class="jxr_linenumber" name="363" href="#363">363</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="364" href="#364">364</a> <strong class="jxr_keyword">boolean</strong> matches(Class type);
<a class="jxr_linenumber" name="365" href="#365">365</a>
<a class="jxr_linenumber" name="366" href="#366">366</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="367" href="#367">367</a> <em class="jxr_javadoccomment"> * Test for a resource.</em>
<a class="jxr_linenumber" name="368" href="#368">368</a> <em class="jxr_javadoccomment"> * @param resource The URI to the resource.</em>
<a class="jxr_linenumber" name="369" href="#369">369</a> <em class="jxr_javadoccomment"> * @return true if the resource matches.</em>
<a class="jxr_linenumber" name="370" href="#370">370</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="371" href="#371">371</a> <strong class="jxr_keyword">boolean</strong> matches(URI resource);
<a class="jxr_linenumber" name="372" href="#372">372</a>
<a class="jxr_linenumber" name="373" href="#373">373</a> <strong class="jxr_keyword">boolean</strong> doesMatchClass();
<a class="jxr_linenumber" name="374" href="#374">374</a> <strong class="jxr_keyword">boolean</strong> doesMatchResource();
<a class="jxr_linenumber" name="375" href="#375">375</a> }
<a class="jxr_linenumber" name="376" href="#376">376</a>
<a class="jxr_linenumber" name="377" href="#377">377</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="378" href="#378">378</a> <em class="jxr_javadoccomment"> * Test against a Class.</em>
<a class="jxr_linenumber" name="379" href="#379">379</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="380" href="#380">380</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">ClassTest</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> {
<a class="jxr_linenumber" name="381" href="#381">381</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(URI resource) {
<a class="jxr_linenumber" name="382" href="#382">382</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException();
<a class="jxr_linenumber" name="383" href="#383">383</a> }
<a class="jxr_linenumber" name="384" href="#384">384</a>
<a class="jxr_linenumber" name="385" href="#385">385</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> doesMatchClass() {
<a class="jxr_linenumber" name="386" href="#386">386</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="387" href="#387">387</a> }
<a class="jxr_linenumber" name="388" href="#388">388</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> doesMatchResource() {
<a class="jxr_linenumber" name="389" href="#389">389</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="390" href="#390">390</a> }
<a class="jxr_linenumber" name="391" href="#391">391</a> }
<a class="jxr_linenumber" name="392" href="#392">392</a>
<a class="jxr_linenumber" name="393" href="#393">393</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="394" href="#394">394</a> <em class="jxr_javadoccomment"> * Test against a resource.</em>
<a class="jxr_linenumber" name="395" href="#395">395</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="396" href="#396">396</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">ResourceTest</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">Test</a> {
<a class="jxr_linenumber" name="397" href="#397">397</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(Class cls) {
<a class="jxr_linenumber" name="398" href="#398">398</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException();
<a class="jxr_linenumber" name="399" href="#399">399</a> }
<a class="jxr_linenumber" name="400" href="#400">400</a>
<a class="jxr_linenumber" name="401" href="#401">401</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> doesMatchClass() {
<a class="jxr_linenumber" name="402" href="#402">402</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="403" href="#403">403</a> }
<a class="jxr_linenumber" name="404" href="#404">404</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> doesMatchResource() {
<a class="jxr_linenumber" name="405" href="#405">405</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="406" href="#406">406</a> }
<a class="jxr_linenumber" name="407" href="#407">407</a> }
<a class="jxr_linenumber" name="408" href="#408">408</a>
<a class="jxr_linenumber" name="409" href="#409">409</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="410" href="#410">410</a> <em class="jxr_javadoccomment"> * A Test that checks to see if each class is assignable to the provided class. Note</em>
<a class="jxr_linenumber" name="411" href="#411">411</a> <em class="jxr_javadoccomment"> * that this test will match the parent type itself if it is presented for matching.</em>
<a class="jxr_linenumber" name="412" href="#412">412</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="413" href="#413">413</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">IsA</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">ClassTest</a> {
<a class="jxr_linenumber" name="414" href="#414">414</a> <strong class="jxr_keyword">private</strong> Class parent;
<a class="jxr_linenumber" name="415" href="#415">415</a>
<a class="jxr_linenumber" name="416" href="#416">416</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="417" href="#417">417</a> <em class="jxr_javadoccomment"> * Constructs an IsA test using the supplied Class as the parent class/interface.</em>
<a class="jxr_linenumber" name="418" href="#418">418</a> <em class="jxr_javadoccomment"> * @param parentType The parent class to check for.</em>
<a class="jxr_linenumber" name="419" href="#419">419</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="420" href="#420">420</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">IsA</a>(Class parentType) { <strong class="jxr_keyword">this</strong>.parent = parentType; }
<a class="jxr_linenumber" name="421" href="#421">421</a>
<a class="jxr_linenumber" name="422" href="#422">422</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="423" href="#423">423</a> <em class="jxr_javadoccomment"> * Returns true if type is assignable to the parent type supplied in the constructor.</em>
<a class="jxr_linenumber" name="424" href="#424">424</a> <em class="jxr_javadoccomment"> * @param type The Class to check.</em>
<a class="jxr_linenumber" name="425" href="#425">425</a> <em class="jxr_javadoccomment"> * @return true if the Class matches.</em>
<a class="jxr_linenumber" name="426" href="#426">426</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="427" href="#427">427</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(Class type) {
<a class="jxr_linenumber" name="428" href="#428">428</a> <strong class="jxr_keyword">return</strong> type != <strong class="jxr_keyword">null</strong> &amp;&amp; parent.isAssignableFrom(type);
<a class="jxr_linenumber" name="429" href="#429">429</a> }
<a class="jxr_linenumber" name="430" href="#430">430</a>
<a class="jxr_linenumber" name="431" href="#431">431</a> @Override
<a class="jxr_linenumber" name="432" href="#432">432</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="433" href="#433">433</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"is assignable to "</span> + parent.getSimpleName();
<a class="jxr_linenumber" name="434" href="#434">434</a> }
<a class="jxr_linenumber" name="435" href="#435">435</a> }
<a class="jxr_linenumber" name="436" href="#436">436</a>
<a class="jxr_linenumber" name="437" href="#437">437</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="438" href="#438">438</a> <em class="jxr_javadoccomment"> * A Test that checks to see if each class name ends with the provided suffix.</em>
<a class="jxr_linenumber" name="439" href="#439">439</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="440" href="#440">440</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">NameEndsWith</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">ClassTest</a> {
<a class="jxr_linenumber" name="441" href="#441">441</a> <strong class="jxr_keyword">private</strong> String suffix;
<a class="jxr_linenumber" name="442" href="#442">442</a>
<a class="jxr_linenumber" name="443" href="#443">443</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="444" href="#444">444</a> <em class="jxr_javadoccomment"> * Constructs a NameEndsWith test using the supplied suffix.</em>
<a class="jxr_linenumber" name="445" href="#445">445</a> <em class="jxr_javadoccomment"> * @param suffix the String suffix to check for.</em>
<a class="jxr_linenumber" name="446" href="#446">446</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="447" href="#447">447</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">NameEndsWith</a>(String suffix) { <strong class="jxr_keyword">this</strong>.suffix = suffix; }
<a class="jxr_linenumber" name="448" href="#448">448</a>
<a class="jxr_linenumber" name="449" href="#449">449</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="450" href="#450">450</a> <em class="jxr_javadoccomment"> * Returns true if type name ends with the suffix supplied in the constructor.</em>
<a class="jxr_linenumber" name="451" href="#451">451</a> <em class="jxr_javadoccomment"> * @param type The Class to check.</em>
<a class="jxr_linenumber" name="452" href="#452">452</a> <em class="jxr_javadoccomment"> * @return true if the Class matches.</em>
<a class="jxr_linenumber" name="453" href="#453">453</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="454" href="#454">454</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(Class type) {
<a class="jxr_linenumber" name="455" href="#455">455</a> <strong class="jxr_keyword">return</strong> type != <strong class="jxr_keyword">null</strong> &amp;&amp; type.getName().endsWith(suffix);
<a class="jxr_linenumber" name="456" href="#456">456</a> }
<a class="jxr_linenumber" name="457" href="#457">457</a>
<a class="jxr_linenumber" name="458" href="#458">458</a> @Override
<a class="jxr_linenumber" name="459" href="#459">459</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="460" href="#460">460</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"ends with the suffix "</span> + suffix;
<a class="jxr_linenumber" name="461" href="#461">461</a> }
<a class="jxr_linenumber" name="462" href="#462">462</a> }
<a class="jxr_linenumber" name="463" href="#463">463</a>
<a class="jxr_linenumber" name="464" href="#464">464</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="465" href="#465">465</a> <em class="jxr_javadoccomment"> * A Test that checks to see if each class is annotated with a specific annotation. If it</em>
<a class="jxr_linenumber" name="466" href="#466">466</a> <em class="jxr_javadoccomment"> * is, then the test returns true, otherwise false.</em>
<a class="jxr_linenumber" name="467" href="#467">467</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="468" href="#468">468</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">AnnotatedWith</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">ClassTest</a> {
<a class="jxr_linenumber" name="469" href="#469">469</a> <strong class="jxr_keyword">private</strong> Class&lt;? <strong class="jxr_keyword">extends</strong> Annotation&gt; annotation;
<a class="jxr_linenumber" name="470" href="#470">470</a>
<a class="jxr_linenumber" name="471" href="#471">471</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="472" href="#472">472</a> <em class="jxr_javadoccomment"> * Constructs an AnnotatedWith test for the specified annotation type.</em>
<a class="jxr_linenumber" name="473" href="#473">473</a> <em class="jxr_javadoccomment"> * @param annotation The annotation to check for.</em>
<a class="jxr_linenumber" name="474" href="#474">474</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="475" href="#475">475</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">AnnotatedWith</a>(Class&lt;? <strong class="jxr_keyword">extends</strong> Annotation&gt; annotation) {
<a class="jxr_linenumber" name="476" href="#476">476</a> <strong class="jxr_keyword">this</strong>.annotation = annotation;
<a class="jxr_linenumber" name="477" href="#477">477</a> }
<a class="jxr_linenumber" name="478" href="#478">478</a>
<a class="jxr_linenumber" name="479" href="#479">479</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="480" href="#480">480</a> <em class="jxr_javadoccomment"> * Returns true if the type is annotated with the class provided to the constructor.</em>
<a class="jxr_linenumber" name="481" href="#481">481</a> <em class="jxr_javadoccomment"> * @param type the Class to match against.</em>
<a class="jxr_linenumber" name="482" href="#482">482</a> <em class="jxr_javadoccomment"> * @return true if the Classes match.</em>
<a class="jxr_linenumber" name="483" href="#483">483</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="484" href="#484">484</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(Class type) {
<a class="jxr_linenumber" name="485" href="#485">485</a> <strong class="jxr_keyword">return</strong> type != <strong class="jxr_keyword">null</strong> &amp;&amp; type.isAnnotationPresent(annotation);
<a class="jxr_linenumber" name="486" href="#486">486</a> }
<a class="jxr_linenumber" name="487" href="#487">487</a>
<a class="jxr_linenumber" name="488" href="#488">488</a> @Override
<a class="jxr_linenumber" name="489" href="#489">489</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="490" href="#490">490</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"annotated with @"</span> + annotation.getSimpleName();
<a class="jxr_linenumber" name="491" href="#491">491</a> }
<a class="jxr_linenumber" name="492" href="#492">492</a> }
<a class="jxr_linenumber" name="493" href="#493">493</a>
<a class="jxr_linenumber" name="494" href="#494">494</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="495" href="#495">495</a> <em class="jxr_javadoccomment"> * A Test that checks to see if the class name matches.</em>
<a class="jxr_linenumber" name="496" href="#496">496</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="497" href="#497">497</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">NameIs</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">ResourceTest</a> {
<a class="jxr_linenumber" name="498" href="#498">498</a> <strong class="jxr_keyword">private</strong> String name;
<a class="jxr_linenumber" name="499" href="#499">499</a>
<a class="jxr_linenumber" name="500" href="#500">500</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../../org/apache/logging/log4j/core/config/plugins/ResolverUtil.html">NameIs</a>(String name) { <strong class="jxr_keyword">this</strong>.name = <span class="jxr_string">"/"</span> + name; }
<a class="jxr_linenumber" name="501" href="#501">501</a>
<a class="jxr_linenumber" name="502" href="#502">502</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> matches(URI resource) {
<a class="jxr_linenumber" name="503" href="#503">503</a> <strong class="jxr_keyword">return</strong> (resource.getPath().endsWith(name));
<a class="jxr_linenumber" name="504" href="#504">504</a> }
<a class="jxr_linenumber" name="505" href="#505">505</a>
<a class="jxr_linenumber" name="506" href="#506">506</a> @Override <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="507" href="#507">507</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">"named "</span> + name;
<a class="jxr_linenumber" name="508" href="#508">508</a> }
<a class="jxr_linenumber" name="509" href="#509">509</a> }
<a class="jxr_linenumber" name="510" href="#510">510</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>