Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.4.0-RC2 / shiro-event / xref / org / apache / shiro / event / support / EventListenerComparator.html
blob: 8764dc4099e37730fe38f5bc9023100cba1414a5 [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>EventListenerComparator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/event/support/EventListenerComparator.html">View Javadoc</a></div><pre>
<a class="jxr_linenumber" name="L1" href="#L1">1</a> <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="L2" href="#L2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a class="jxr_linenumber" name="L3" href="#L3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2." target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.</a>0</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"> * Unless required by applicable law or agreed to in writing,</em>
<a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * under the License.</em>
<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="L19" href="#L19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.event.support;
<a class="jxr_linenumber" name="L20" href="#L20">20</a>
<a class="jxr_linenumber" name="L21" href="#L21">21</a> <strong class="jxr_keyword">import</strong> java.util.Comparator;
<a class="jxr_linenumber" name="L22" href="#L22">22</a>
<a class="jxr_linenumber" name="L23" href="#L23">23</a> <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="L24" href="#L24">24</a> <em class="jxr_javadoccomment"> * Compares two event listeners to determine the order in which they should be invoked when an event is dispatched.</em>
<a class="jxr_linenumber" name="L25" href="#L25">25</a> <em class="jxr_javadoccomment"> * The lower the order, the sooner it will be invoked (the higher its precedence). The higher the order, the later</em>
<a class="jxr_linenumber" name="L26" href="#L26">26</a> <em class="jxr_javadoccomment"> * it will be invoked (the lower its precedence).</em>
<a class="jxr_linenumber" name="L27" href="#L27">27</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L28" href="#L28">28</a> <em class="jxr_javadoccomment"> * TypedEventListeners have a higher precedence (i.e. a lower order) than standard EventListener instances. Standard</em>
<a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment"> * EventListener instances have the same order priority.</em>
<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * &lt;p/&gt;</em>
<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * When both objects being compared are TypedEventListeners, they are ordered according to the rules of the</em>
<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * {@link EventClassComparator}, using the TypedEventListeners'</em>
<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * {@link TypedEventListener#getEventType() eventType}.</em>
<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @since 1.3</em>
<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/event/support/EventListenerComparator.html">EventListenerComparator</a> <strong class="jxr_keyword">implements</strong> Comparator&lt;EventListener&gt; {
<a class="jxr_linenumber" name="L38" href="#L38">38</a>
<a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_comment">//event class comparator is stateless, so we can retain an instance:</em>
<a class="jxr_linenumber" name="L40" href="#L40">40</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../../org/apache/shiro/event/support/EventClassComparator.html">EventClassComparator</a> EVENT_CLASS_COMPARATOR = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/shiro/event/support/EventClassComparator.html">EventClassComparator</a>();
<a class="jxr_linenumber" name="L41" href="#L41">41</a>
<a class="jxr_linenumber" name="L42" href="#L42">42</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compare(<a href="../../../../../org/apache/shiro/event/support/EventListener.html">EventListener</a> a, <a href="../../../../../org/apache/shiro/event/support/EventListener.html">EventListener</a> b) {
<a class="jxr_linenumber" name="L43" href="#L43">43</a> <strong class="jxr_keyword">if</strong> (a == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L44" href="#L44">44</a> <strong class="jxr_keyword">if</strong> (b == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L45" href="#L45">45</a> <strong class="jxr_keyword">return</strong> 0;
<a class="jxr_linenumber" name="L46" href="#L46">46</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L47" href="#L47">47</a> <strong class="jxr_keyword">return</strong> -1;
<a class="jxr_linenumber" name="L48" href="#L48">48</a> }
<a class="jxr_linenumber" name="L49" href="#L49">49</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (b == <strong class="jxr_keyword">null</strong>) {
<a class="jxr_linenumber" name="L50" href="#L50">50</a> <strong class="jxr_keyword">return</strong> 1;
<a class="jxr_linenumber" name="L51" href="#L51">51</a> } <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong> (a == b || a.equals(b)) {
<a class="jxr_linenumber" name="L52" href="#L52">52</a> <strong class="jxr_keyword">return</strong> 0;
<a class="jxr_linenumber" name="L53" href="#L53">53</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L54" href="#L54">54</a> <strong class="jxr_keyword">if</strong> (a instanceof TypedEventListener) {
<a class="jxr_linenumber" name="L55" href="#L55">55</a> <a href="../../../../../org/apache/shiro/event/support/TypedEventListener.html">TypedEventListener</a> ta = (TypedEventListener)a;
<a class="jxr_linenumber" name="L56" href="#L56">56</a> <strong class="jxr_keyword">if</strong> (b instanceof TypedEventListener) {
<a class="jxr_linenumber" name="L57" href="#L57">57</a> <a href="../../../../../org/apache/shiro/event/support/TypedEventListener.html">TypedEventListener</a> tb = (TypedEventListener)b;
<a class="jxr_linenumber" name="L58" href="#L58">58</a> <strong class="jxr_keyword">return</strong> EVENT_CLASS_COMPARATOR.compare(ta.getEventType(), tb.getEventType());
<a class="jxr_linenumber" name="L59" href="#L59">59</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">return</strong> -1; <em class="jxr_comment">//TypedEventListeners are 'less than' (higher priority) than non typed</em>
<a class="jxr_linenumber" name="L61" href="#L61">61</a> }
<a class="jxr_linenumber" name="L62" href="#L62">62</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L63" href="#L63">63</a> <strong class="jxr_keyword">if</strong> (b instanceof TypedEventListener) {
<a class="jxr_linenumber" name="L64" href="#L64">64</a> <strong class="jxr_keyword">return</strong> 1;
<a class="jxr_linenumber" name="L65" href="#L65">65</a> } <strong class="jxr_keyword">else</strong> {
<a class="jxr_linenumber" name="L66" href="#L66">66</a> <strong class="jxr_keyword">return</strong> 0;
<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> }
<a class="jxr_linenumber" name="L70" href="#L70">70</a> }
<a class="jxr_linenumber" name="L71" href="#L71">71</a> }
</pre>
<hr/>
<div id="footer">Copyright &#169; 2004&#x2013;2016 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div>
</body>
</html>