| <!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>Event xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/archiva/event/Event.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.time.LocalDateTime; |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.EventObject; |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * Base class for events. Events have a type and a source.</em> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * The source is the instance that raised the event.</em> |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * There are different event types for a given event. The types are represented in a hierarchical structure.</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"> * Events can be chained, which means a event listener can catch events and rethrow them as its own event.</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"> */</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a> <strong class="jxr_keyword">extends</strong> EventObject <strong class="jxr_keyword">implements</strong> Cloneable { |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</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 = -7171846575892044990L; |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> EventType<Event> ANY = EventType.ROOT; |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> <a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a> previous; |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> EventType<? <strong class="jxr_keyword">extends</strong> Event> type; |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> LocalDateTime createTime; |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">public</strong> <a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a>(EventType<? <strong class="jxr_keyword">extends</strong> Event> type, Object originator) { |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">super</strong>(originator); |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <strong class="jxr_keyword">this</strong>.type = type; |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">this</strong>.createTime = LocalDateTime.now(); |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> } |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">private</strong> <a nam<a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a>ent" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a>(<a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a> previous, Object originator) { |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">super</strong>(originator); |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">this</strong>.previous = previous; |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> <strong class="jxr_keyword">this</strong>.type = previous.getType(); |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">this</strong>.createTime = previous.getCreateTime(); |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> } |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * Returns the event type that is associated with this event instance.</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> * @return the event type</em> |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <strong class="jxr_keyword">public</strong> EventType<? <strong class="jxr_keyword">extends</strong> Event> getType() { |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <strong class="jxr_keyword">return</strong> type; |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> }; |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * Returns the time, when the event was created.</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @return</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> <strong class="jxr_keyword">public</strong> LocalDateTime getCreateTime() { |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> <strong class="jxr_keyword">return</strong> createTime; |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> } |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * Recreates the event with the given instance as the new source. The</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * current source is stored in the previous event.</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @param newSource The new source</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> * @return a new event instance, where <code>this</code> is stored as previous event</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> <strong class="jxr_keyword">public</strong> <a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a> copyFor(Object newSource) { |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <a name="Event" hr<a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a>./../../../org/apache/archiva/event/Event.html#Event">Event</a> newEvent = (<a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a>) <strong class="jxr_keyword">this</strong>.clone(); |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> newEvent.previous = <strong class="jxr_keyword">this</strong>; |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> newEvent.source = newSource; |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <strong class="jxr_keyword">return</strong> newEvent; |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> } |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * Returns the previous event or <code>null</code>, if this is a root event.</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @return the previous event or <code>null</code>, if it does not exist</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> <strong class="jxr_keyword">public</strong> <a name="Event" href="../../../../org/apache/archiva/event/Event.html#Event">Event</a> getPreviousEvent() { |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> <strong class="jxr_keyword">return</strong> previous; |
| <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> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * Returns <code>true</code>, if the event has a previous event.</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * @return <code>true</code>, if this has a previous event, otherwise <code>false</code></em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasPreviousEvent() { |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <strong class="jxr_keyword">return</strong> previous!=<strong class="jxr_keyword">null</strong>; |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> } |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> @Override |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> <strong class="jxr_keyword">protected</strong> Object clone() { |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <strong class="jxr_keyword">try</strong> { |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">super</strong>.clone(); |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> } <strong class="jxr_keyword">catch</strong> (CloneNotSupportedException e) { |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_comment">// this should not happen</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> RuntimeException(<span class="jxr_string">"Event is not clonable"</span>); |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> } |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> } |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2006–2019 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
