blob: b47e95de71ed157966e0fef37c371c75f54ed615 [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>EventType xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/archiva/event/EventType.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.archiva.event;
<a class="jxr_linenumber" name="L2" href="#L2">2</a>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L21" href="#L21">21</a>
<a class="jxr_linenumber" name="L22" href="#L22">22</a> <strong class="jxr_keyword">import</strong> java.io.InvalidObjectException;
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.io.ObjectStreamException;
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.io.Serializable;
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.*;
<a class="jxr_linenumber" name="L26" href="#L26">26</a>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * Event types define a hierarchical structure of events. Each event is bound to a certain event type.</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * All event types have a super type, only the root event type {@link EventType#ROOT} has no super type.</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Event types should be stored as static fields on the events itself.</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * @param &lt;T&gt; The type class parameter allows to define the types in a type safe way and represents a event class,</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * where the type is associated to.</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> EventType&lt;T <strong class="jxr_keyword">extends</strong> Event&gt; <strong class="jxr_keyword">implements</strong> Serializable {
<a class="jxr_linenumber" name="L37" href="#L37">37</a>
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> EventType&lt;Event&gt; ROOT = <strong class="jxr_keyword">new</strong> EventType&lt;&gt;();
<a class="jxr_linenumber" name="L40" href="#L40">40</a>
<a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String name;
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> EventType&lt;? <strong class="jxr_keyword">super</strong> T&gt; superType;
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">private</strong> WeakHashMap&lt;EventType&lt;? <strong class="jxr_keyword">extends</strong> T&gt;, Void&gt; subTypes;
<a class="jxr_linenumber" name="L44" href="#L44">44</a>
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * Creates a type with the given name and the root type as parent.</em>
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @param name the name of the new type</em>
<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">public</strong> <a name="EventType" href="../../../../org/apache/archiva/event/EventType.html#EventType">EventType</a>(String name) {
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">this</strong>.superType = ROOT;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="L52" href="#L52">52</a> }
<a class="jxr_linenumber" name="L53" href="#L53">53</a>
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <em class="jxr_javadoccomment"> * Creates a event type instance with the given super type and name.</em>
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * @param superType The super type or &lt;code&gt;null&lt;/code&gt;, if this is the root type.</em>
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * @param name</em>
<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">public</strong> <a name="EventType" href="../../../../org/apache/archiva/event/EventType.html#EventType">EventType</a>(EventType&lt;? <strong class="jxr_keyword">super</strong> T&gt; superType, String name) {
<a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">if</strong> (superType==<strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"Super Type may not be null"</span>);
<a class="jxr_linenumber" name="L63" href="#L63">63</a> }
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">this</strong>.name = name;
<a class="jxr_linenumber" name="L65" href="#L65">65</a> <strong class="jxr_keyword">this</strong>.superType = superType;
<a class="jxr_linenumber" name="L66" href="#L66">66</a> superType.register(<strong class="jxr_keyword">this</strong>);
<a class="jxr_linenumber" name="L67" href="#L67">67</a> }
<a class="jxr_linenumber" name="L68" href="#L68">68</a>
<a class="jxr_linenumber" name="L69" href="#L69">69</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L70" href="#L70">70</a> <em class="jxr_javadoccomment"> * Creates the root type</em>
<a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L72" href="#L72">72</a> <strong class="jxr_keyword">private</strong> <a name="EventType" href="../../../../org/apache/archiva/event/EventType.html#EventType">EventType</a>() {
<a class="jxr_linenumber" name="L73" href="#L73">73</a> <strong class="jxr_keyword">this</strong>.name=<span class="jxr_string">"ROOT"</span>;
<a class="jxr_linenumber" name="L74" href="#L74">74</a> <strong class="jxr_keyword">this</strong>.superType=<strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L75" href="#L75">75</a> }
<a class="jxr_linenumber" name="L76" href="#L76">76</a>
<a class="jxr_linenumber" name="L77" href="#L77">77</a> <strong class="jxr_keyword">public</strong> String name() {
<a class="jxr_linenumber" name="L78" href="#L78">78</a> <strong class="jxr_keyword">return</strong> name;
<a class="jxr_linenumber" name="L79" href="#L79">79</a> }
<a class="jxr_linenumber" name="L80" href="#L80">80</a>
<a class="jxr_linenumber" name="L81" href="#L81">81</a> <strong class="jxr_keyword">public</strong> EventType&lt;? <strong class="jxr_keyword">super</strong> T&gt; getSuperType() {
<a class="jxr_linenumber" name="L82" href="#L82">82</a> <strong class="jxr_keyword">return</strong> superType;
<a class="jxr_linenumber" name="L83" href="#L83">83</a> }
<a class="jxr_linenumber" name="L84" href="#L84">84</a>
<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> register(EventType&lt;? <strong class="jxr_keyword">extends</strong> T&gt; subType) {
<a class="jxr_linenumber" name="L86" href="#L86">86</a> <strong class="jxr_keyword">if</strong> (subTypes == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L87" href="#L87">87</a> subTypes = <strong class="jxr_keyword">new</strong> WeakHashMap&lt;&gt;();
<a class="jxr_linenumber" name="L88" href="#L88">88</a> }
<a class="jxr_linenumber" name="L89" href="#L89">89</a> <strong class="jxr_keyword">for</strong> (EventType&lt;? <strong class="jxr_keyword">extends</strong> T&gt; t : subTypes.keySet()) {
<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">if</strong> (((t.name == <strong class="jxr_keyword">null</strong> &amp;&amp; subType.name == <strong class="jxr_keyword">null</strong>) || (t.name != <strong class="jxr_keyword">null</strong> &amp;&amp; t.name.equals(subType.name)))) {
<a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"EventType \&quot;"</span> + subType + <span class="jxr_string">"\&quot;"</span>
<a class="jxr_linenumber" name="L92" href="#L92">92</a> + <span class="jxr_string">"with parent \&quot;"</span> + subType.getSuperType()+<span class="jxr_string">"\&quot; already exists"</span>);
<a class="jxr_linenumber" name="L93" href="#L93">93</a> }
<a class="jxr_linenumber" name="L94" href="#L94">94</a> }
<a class="jxr_linenumber" name="L95" href="#L95">95</a> subTypes.put(subType, <strong class="jxr_keyword">null</strong>);
<a class="jxr_linenumber" name="L96" href="#L96">96</a> }
<a class="jxr_linenumber" name="L97" href="#L97">97</a>
<a class="jxr_linenumber" name="L98" href="#L98">98</a>
<a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> List&lt;EventType&lt;?&gt;&gt; fetchSuperTypes(EventType&lt;?&gt; type) {
<a class="jxr_linenumber" name="L100" href="#L100">100</a> List&lt;EventType&lt;?&gt;&gt; typeList = <strong class="jxr_keyword">new</strong> ArrayList&lt;&gt;();
<a class="jxr_linenumber" name="L101" href="#L101">101</a> EventType&lt;?&gt; cType = type;
<a class="jxr_linenumber" name="L102" href="#L102">102</a> <strong class="jxr_keyword">while</strong> (cType!=<strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L103" href="#L103">103</a> typeList.add(cType);
<a class="jxr_linenumber" name="L104" href="#L104">104</a> cType = cType.getSuperType();
<a class="jxr_linenumber" name="L105" href="#L105">105</a> }
<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">return</strong> typeList;
<a class="jxr_linenumber" name="L107" href="#L107">107</a> }
<a class="jxr_linenumber" name="L108" href="#L108">108</a>
<a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">boolean</strong> isInstanceOf(EventType&lt;?&gt; type, EventType&lt;?&gt; baseType) {
<a class="jxr_linenumber" name="L110" href="#L110">110</a> EventType&lt;?&gt; cType = type;
<a class="jxr_linenumber" name="L111" href="#L111">111</a> <strong class="jxr_keyword">while</strong>(cType!=<strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L112" href="#L112">112</a> <strong class="jxr_keyword">if</strong> (cType == baseType) {
<a class="jxr_linenumber" name="L113" href="#L113">113</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
<a class="jxr_linenumber" name="L114" href="#L114">114</a> }
<a class="jxr_linenumber" name="L115" href="#L115">115</a> cType = cType.getSuperType();
<a class="jxr_linenumber" name="L116" href="#L116">116</a> }
<a class="jxr_linenumber" name="L117" href="#L117">117</a> <strong class="jxr_keyword">return</strong> false;
<a class="jxr_linenumber" name="L118" href="#L118">118</a> }
<a class="jxr_linenumber" name="L119" href="#L119">119</a>
<a class="jxr_linenumber" name="L120" href="#L120">120</a>
<a class="jxr_linenumber" name="L121" href="#L121">121</a> <strong class="jxr_keyword">private</strong> Object writeReplace() <strong class="jxr_keyword">throws</strong> ObjectStreamException {
<a class="jxr_linenumber" name="L122" href="#L122">122</a> Deque&lt;String&gt; path = <strong class="jxr_keyword">new</strong> LinkedList&lt;String&gt;();
<a class="jxr_linenumber" name="L123" href="#L123">123</a> EventType&lt;?&gt; t = <strong class="jxr_keyword">this</strong>;
<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">while</strong> (t != ROOT) {
<a class="jxr_linenumber" name="L125" href="#L125">125</a> path.addFirst(t.name);
<a class="jxr_linenumber" name="L126" href="#L126">126</a> t = t.superType;
<a class="jxr_linenumber" name="L127" href="#L127">127</a> }
<a class="jxr_linenumber" name="L128" href="#L128">128</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> EventTypeSerialization(<strong class="jxr_keyword">new</strong> ArrayList&lt;&gt;(path));
<a class="jxr_linenumber" name="L129" href="#L129">129</a> }
<a class="jxr_linenumber" name="L130" href="#L130">130</a>
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> EventTypeSerialization <strong class="jxr_keyword">implements</strong> Serializable {
<a class="jxr_linenumber" name="L132" href="#L132">132</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 = 1841649460281865547L;
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <strong class="jxr_keyword">private</strong> List&lt;String&gt; path;
<a class="jxr_linenumber" name="L134" href="#L134">134</a>
<a class="jxr_linenumber" name="L135" href="#L135">135</a> <strong class="jxr_keyword">public</strong> EventTypeSerialization(List&lt;String&gt; path) {
<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">this</strong>.path = path;
<a class="jxr_linenumber" name="L137" href="#L137">137</a> }
<a class="jxr_linenumber" name="L138" href="#L138">138</a>
<a class="jxr_linenumber" name="L139" href="#L139">139</a> <strong class="jxr_keyword">private</strong> Object readResolve() <strong class="jxr_keyword">throws</strong> ObjectStreamException {
<a class="jxr_linenumber" name="L140" href="#L140">140</a> <a name="EventType" href="../../../../org/apache/archiva/event/EventType.html#EventType">EventType</a> t = ROOT;
<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i &lt; path.size(); ++i) {
<a class="jxr_linenumber" name="L142" href="#L142">142</a> String p = path.get(i);
<a class="jxr_linenumber" name="L143" href="#L143">143</a> <strong class="jxr_keyword">if</strong> (t.subTypes != <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L144" href="#L144">144</a> EventType&lt;?&gt; s = findSubType(t.subTypes.keySet(), p);
<a class="jxr_linenumber" name="L145" href="#L145">145</a> <strong class="jxr_keyword">if</strong> (s == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidObjectException(<span class="jxr_string">"Cannot find event type \&quot;"</span> + p + <span class="jxr_string">"\&quot; (of "</span> + t + <span class="jxr_string">")"</span>);
<a class="jxr_linenumber" name="L147" href="#L147">147</a> }
<a class="jxr_linenumber" name="L148" href="#L148">148</a> t = s;
<a class="jxr_linenumber" name="L149" href="#L149">149</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L150" href="#L150">150</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> InvalidObjectException(<span class="jxr_string">"Cannot find event type \&quot;"</span> + p + <span class="jxr_string">"\&quot; (of "</span> + t + <span class="jxr_string">")"</span>);
<a class="jxr_linenumber" name="L151" href="#L151">151</a> }
<a class="jxr_linenumber" name="L152" href="#L152">152</a> }
<a class="jxr_linenumber" name="L153" href="#L153">153</a> <strong class="jxr_keyword">return</strong> t;
<a class="jxr_linenumber" name="L154" href="#L154">154</a> }
<a class="jxr_linenumber" name="L155" href="#L155">155</a>
<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">private</strong> EventType&lt;?&gt; findSubType(Set&lt;EventType&gt; subTypes, String name) {
<a class="jxr_linenumber" name="L157" href="#L157">157</a> <strong class="jxr_keyword">for</strong> (<a name="EventType" href="../../../../org/apache/archiva/event/EventType.html#EventType">EventType</a> t : subTypes) {
<a class="jxr_linenumber" name="L158" href="#L158">158</a> <strong class="jxr_keyword">if</strong> (((t.name == <strong class="jxr_keyword">null</strong> &amp;&amp; name == <strong class="jxr_keyword">null</strong>) || (t.name != <strong class="jxr_keyword">null</strong> &amp;&amp; t.name.equals(name)))) {
<a class="jxr_linenumber" name="L159" href="#L159">159</a> <strong class="jxr_keyword">return</strong> t;
<a class="jxr_linenumber" name="L160" href="#L160">160</a> }
<a class="jxr_linenumber" name="L161" href="#L161">161</a> }
<a class="jxr_linenumber" name="L162" href="#L162">162</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
<a class="jxr_linenumber" name="L163" href="#L163">163</a> }
<a class="jxr_linenumber" name="L164" href="#L164">164</a>
<a class="jxr_linenumber" name="L165" href="#L165">165</a> }
<a class="jxr_linenumber" name="L166" href="#L166">166</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2006&#x2013;2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>