blob: 64968609b8996f4e55489f530c029fb717bf31e7 [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>MarkerManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/logging/log4j/MarkerManager.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a> <em class="jxr_comment"> * contributor license agreements. See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a> <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a> <em class="jxr_comment"> * The ASF licenses this file to You under the Apache license, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a> <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a> <em class="jxr_comment"> * the License. You may obtain a copy of the License at</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"> * <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="10" href="#10">10</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a> <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a> <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a> <em class="jxr_comment"> * See the license for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a> <em class="jxr_comment"> * limitations under the license.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a> <strong class="jxr_keyword">package</strong> org.apache.logging.log4j;
<a class="jxr_linenumber" name="18" href="#18">18</a>
<a class="jxr_linenumber" name="19" href="#19">19</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentHashMap;
<a class="jxr_linenumber" name="20" href="#20">20</a> <strong class="jxr_keyword">import</strong> java.util.concurrent.ConcurrentMap;
<a class="jxr_linenumber" name="21" href="#21">21</a>
<a class="jxr_linenumber" name="22" href="#22">22</a>
<a class="jxr_linenumber" name="23" href="#23">23</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="24" href="#24">24</a> <em class="jxr_javadoccomment"> * Applications create Markers by using the Marker Manager. All Markers created by this Manager are</em>
<a class="jxr_linenumber" name="25" href="#25">25</a> <em class="jxr_javadoccomment"> * immutable.</em>
<a class="jxr_linenumber" name="26" href="#26">26</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="27" href="#27">27</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/logging/log4j/MarkerManager.html">MarkerManager</a> {
<a class="jxr_linenumber" name="28" href="#28">28</a>
<a class="jxr_linenumber" name="29" href="#29">29</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> ConcurrentMap&lt;String, Marker&gt; markerMap = <strong class="jxr_keyword">new</strong> ConcurrentHashMap&lt;String, Marker&gt;();
<a class="jxr_linenumber" name="30" href="#30">30</a>
<a class="jxr_linenumber" name="31" href="#31">31</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/logging/log4j/MarkerManager.html">MarkerManager</a>() {
<a class="jxr_linenumber" name="32" href="#32">32</a> }
<a class="jxr_linenumber" name="33" href="#33">33</a>
<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> <em class="jxr_javadoccomment"> * Retrieve a Marker or create a Marker that has no parent.</em>
<a class="jxr_linenumber" name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @param name The name of the Marker.</em>
<a class="jxr_linenumber" name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * @return The Marker with the specified name.</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">static</strong> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> getMarker(String name) {
<a class="jxr_linenumber" name="40" href="#40">40</a> markerMap.putIfAbsent(name, <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/logging/log4j/MarkerManager.html">Log4JMarker</a>(name));
<a class="jxr_linenumber" name="41" href="#41">41</a> <strong class="jxr_keyword">return</strong> markerMap.get(name);
<a class="jxr_linenumber" name="42" href="#42">42</a> }
<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"> * Retrieves or creates a Marker with the specified parent. The parent must have been previously created.</em>
<a class="jxr_linenumber" name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * @param name The name of the Marker.</em>
<a class="jxr_linenumber" name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * @param parent The name of the parent Marker.</em>
<a class="jxr_linenumber" name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * @return The Marker with the specified name.</em>
<a class="jxr_linenumber" name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if the parent Marker does not exist.</em>
<a class="jxr_linenumber" name="50" href="#50">50</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> getMarker(String name, String parent) {
<a class="jxr_linenumber" name="52" href="#52">52</a> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> parentMarker = markerMap.get(parent);
<a class="jxr_linenumber" name="53" href="#53">53</a> <strong class="jxr_keyword">if</strong> (parentMarker == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="54" href="#54">54</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Parent Marker "</span> + parent + <span class="jxr_string">" has not been defined"</span>);
<a class="jxr_linenumber" name="55" href="#55">55</a> }
<a class="jxr_linenumber" name="56" href="#56">56</a> <strong class="jxr_keyword">return</strong> getMarker(name, parentMarker);
<a class="jxr_linenumber" name="57" href="#57">57</a> }
<a class="jxr_linenumber" name="58" href="#58">58</a>
<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"> * Retrieves or creates a Marker with the specified parent.</em>
<a class="jxr_linenumber" name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param name The name of the Marker.</em>
<a class="jxr_linenumber" name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param parent The parent Marker.</em>
<a class="jxr_linenumber" name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @return The Marker with the specified name.</em>
<a class="jxr_linenumber" name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="65" href="#65">65</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> getMarker(String name, <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> parent) {
<a class="jxr_linenumber" name="66" href="#66">66</a> markerMap.putIfAbsent(name, <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/logging/log4j/MarkerManager.html">Log4JMarker</a>(name, parent));
<a class="jxr_linenumber" name="67" href="#67">67</a> <strong class="jxr_keyword">return</strong> markerMap.get(name);
<a class="jxr_linenumber" name="68" href="#68">68</a> }
<a class="jxr_linenumber" name="69" href="#69">69</a>
<a class="jxr_linenumber" name="70" href="#70">70</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * The actual Marker implementation.</em>
<a class="jxr_linenumber" name="72" href="#72">72</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/logging/log4j/MarkerManager.html">Log4JMarker</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> {
<a class="jxr_linenumber" name="74" href="#74">74</a>
<a class="jxr_linenumber" name="75" href="#75">75</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> serialVersionUID = 100L;
<a class="jxr_linenumber" name="76" href="#76">76</a>
<a class="jxr_linenumber" name="77" href="#77">77</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name;
<a class="jxr_linenumber" name="78" href="#78">78</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> parent;
<a class="jxr_linenumber" name="79" href="#79">79</a>
<a class="jxr_linenumber" name="80" href="#80">80</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/logging/log4j/MarkerManager.html">Log4JMarker</a>(String name) {
<a class="jxr_linenumber" name="81" href="#81">81</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="82" href="#82">82</a> <strong class="jxr_keyword">this</strong>.parent = <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="83" href="#83">83</a> }
<a class="jxr_linenumber" name="84" href="#84">84</a>
<a class="jxr_linenumber" name="85" href="#85">85</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/logging/log4j/MarkerManager.html">Log4JMarker</a>(String name, <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> parent) {
<a class="jxr_linenumber" name="86" href="#86">86</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="87" href="#87">87</a> <strong class="jxr_keyword">this</strong>.parent = parent;
<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">public</strong> String getName() {
<a class="jxr_linenumber" name="91" href="#91">91</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.name;
<a class="jxr_linenumber" name="92" href="#92">92</a> }
<a class="jxr_linenumber" name="93" href="#93">93</a>
<a class="jxr_linenumber" name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> getParent() {
<a class="jxr_linenumber" name="95" href="#95">95</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.parent;
<a class="jxr_linenumber" name="96" href="#96">96</a> }
<a class="jxr_linenumber" name="97" href="#97">97</a>
<a class="jxr_linenumber" name="98" href="#98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isInstanceOf(<a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> m) {
<a class="jxr_linenumber" name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (m == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="100" href="#100">100</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"A marker parameter is required"</span>);
<a class="jxr_linenumber" name="101" href="#101">101</a> }
<a class="jxr_linenumber" name="102" href="#102">102</a> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> test = <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="103" href="#103">103</a> <strong class="jxr_keyword">do</strong> {
<a class="jxr_linenumber" name="104" href="#104">104</a> <strong class="jxr_keyword">if</strong> (test == m) {
<a class="jxr_linenumber" name="105" href="#105">105</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="106" href="#106">106</a> }
<a class="jxr_linenumber" name="107" href="#107">107</a> test = test.getParent();
<a class="jxr_linenumber" name="108" href="#108">108</a> } <strong class="jxr_keyword">while</strong> (test != <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="110" href="#110">110</a> }
<a class="jxr_linenumber" name="111" href="#111">111</a>
<a class="jxr_linenumber" name="112" href="#112">112</a> @Override
<a class="jxr_linenumber" name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o) {
<a class="jxr_linenumber" name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> (<strong class="jxr_keyword">this</strong> == o) {
<a class="jxr_linenumber" name="115" href="#115">115</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="116" href="#116">116</a> }
<a class="jxr_linenumber" name="117" href="#117">117</a> <strong class="jxr_keyword">if</strong> (o == <strong class="jxr_keyword">null</strong> || getClass() != o.getClass()) {
<a class="jxr_linenumber" name="118" href="#118">118</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="119" href="#119">119</a> }
<a class="jxr_linenumber" name="120" href="#120">120</a>
<a class="jxr_linenumber" name="121" href="#121">121</a> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> marker = (Marker) o;
<a class="jxr_linenumber" name="122" href="#122">122</a>
<a class="jxr_linenumber" name="123" href="#123">123</a> <strong class="jxr_keyword">if</strong> (name != <strong class="jxr_keyword">null</strong> ? !name.equals(marker.getName()) : marker.getName() != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="124" href="#124">124</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="125" href="#125">125</a> }
<a class="jxr_linenumber" name="126" href="#126">126</a>
<a class="jxr_linenumber" name="127" href="#127">127</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="128" href="#128">128</a> }
<a class="jxr_linenumber" name="129" href="#129">129</a>
<a class="jxr_linenumber" name="130" href="#130">130</a> @Override
<a class="jxr_linenumber" name="131" href="#131">131</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode() {
<a class="jxr_linenumber" name="132" href="#132">132</a> <strong class="jxr_keyword">return</strong> name != <strong class="jxr_keyword">null</strong> ? name.hashCode() : 0;
<a class="jxr_linenumber" name="133" href="#133">133</a> }
<a class="jxr_linenumber" name="134" href="#134">134</a>
<a class="jxr_linenumber" name="135" href="#135">135</a> <strong class="jxr_keyword">public</strong> String toString() {
<a class="jxr_linenumber" name="136" href="#136">136</a> StringBuilder sb = <strong class="jxr_keyword">new</strong> StringBuilder(name);
<a class="jxr_linenumber" name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (parent != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="138" href="#138">138</a> <a href="../../../../org/apache/logging/log4j/Marker.html">Marker</a> m = parent;
<a class="jxr_linenumber" name="139" href="#139">139</a> sb.append(<span class="jxr_string">"[ "</span>);
<a class="jxr_linenumber" name="140" href="#140">140</a> <strong class="jxr_keyword">boolean</strong> first = <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="141" href="#141">141</a> <strong class="jxr_keyword">while</strong> (m != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="142" href="#142">142</a> <strong class="jxr_keyword">if</strong> (!first) {
<a class="jxr_linenumber" name="143" href="#143">143</a> sb.append(<span class="jxr_string">", "</span>);
<a class="jxr_linenumber" name="144" href="#144">144</a> }
<a class="jxr_linenumber" name="145" href="#145">145</a> sb.append(m.getName());
<a class="jxr_linenumber" name="146" href="#146">146</a> first = false;
<a class="jxr_linenumber" name="147" href="#147">147</a> m = m.getParent();
<a class="jxr_linenumber" name="148" href="#148">148</a> }
<a class="jxr_linenumber" name="149" href="#149">149</a> sb.append(<span class="jxr_string">" ]"</span>);
<a class="jxr_linenumber" name="150" href="#150">150</a> }
<a class="jxr_linenumber" name="151" href="#151">151</a> <strong class="jxr_keyword">return</strong> sb.toString();
<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> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>