blob: 36ac8c631d769873c0a65f5ae60ee08002985363 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.util;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.subject.PrincipalCollection;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.*;<a name="line.23"></a>
<FONT color="green">024</FONT> <a name="line.24"></a>
<FONT color="green">025</FONT> /**<a name="line.25"></a>
<FONT color="green">026</FONT> * Static helper class for use dealing with Collections.<a name="line.26"></a>
<FONT color="green">027</FONT> *<a name="line.27"></a>
<FONT color="green">028</FONT> * @since 0.9<a name="line.28"></a>
<FONT color="green">029</FONT> */<a name="line.29"></a>
<FONT color="green">030</FONT> public class CollectionUtils {<a name="line.30"></a>
<FONT color="green">031</FONT> <a name="line.31"></a>
<FONT color="green">032</FONT> //TODO - complete JavaDoc<a name="line.32"></a>
<FONT color="green">033</FONT> <a name="line.33"></a>
<FONT color="green">034</FONT> public static &lt;E&gt; Set&lt;E&gt; asSet(E... elements) {<a name="line.34"></a>
<FONT color="green">035</FONT> if (elements == null || elements.length == 0) {<a name="line.35"></a>
<FONT color="green">036</FONT> return Collections.emptySet();<a name="line.36"></a>
<FONT color="green">037</FONT> }<a name="line.37"></a>
<FONT color="green">038</FONT> LinkedHashSet&lt;E&gt; set = new LinkedHashSet&lt;E&gt;(elements.length * 4 / 3 + 1);<a name="line.38"></a>
<FONT color="green">039</FONT> Collections.addAll(set, elements);<a name="line.39"></a>
<FONT color="green">040</FONT> return set;<a name="line.40"></a>
<FONT color="green">041</FONT> }<a name="line.41"></a>
<FONT color="green">042</FONT> <a name="line.42"></a>
<FONT color="green">043</FONT> /**<a name="line.43"></a>
<FONT color="green">044</FONT> * Returns {@code true} if the specified {@code Collection} is {@code null} or {@link Collection#isEmpty empty},<a name="line.44"></a>
<FONT color="green">045</FONT> * {@code false} otherwise.<a name="line.45"></a>
<FONT color="green">046</FONT> *<a name="line.46"></a>
<FONT color="green">047</FONT> * @param c the collection to check<a name="line.47"></a>
<FONT color="green">048</FONT> * @return {@code true} if the specified {@code Collection} is {@code null} or {@link Collection#isEmpty empty},<a name="line.48"></a>
<FONT color="green">049</FONT> * {@code false} otherwise.<a name="line.49"></a>
<FONT color="green">050</FONT> * @since 1.0<a name="line.50"></a>
<FONT color="green">051</FONT> */<a name="line.51"></a>
<FONT color="green">052</FONT> public static boolean isEmpty(Collection c) {<a name="line.52"></a>
<FONT color="green">053</FONT> return c == null || c.isEmpty();<a name="line.53"></a>
<FONT color="green">054</FONT> }<a name="line.54"></a>
<FONT color="green">055</FONT> <a name="line.55"></a>
<FONT color="green">056</FONT> /**<a name="line.56"></a>
<FONT color="green">057</FONT> * Returns {@code true} if the specified {@code Map} is {@code null} or {@link Map#isEmpty empty},<a name="line.57"></a>
<FONT color="green">058</FONT> * {@code false} otherwise.<a name="line.58"></a>
<FONT color="green">059</FONT> *<a name="line.59"></a>
<FONT color="green">060</FONT> * @param m the {@code Map} to check<a name="line.60"></a>
<FONT color="green">061</FONT> * @return {@code true} if the specified {@code Map} is {@code null} or {@link Map#isEmpty empty},<a name="line.61"></a>
<FONT color="green">062</FONT> * {@code false} otherwise.<a name="line.62"></a>
<FONT color="green">063</FONT> * @since 1.0<a name="line.63"></a>
<FONT color="green">064</FONT> */<a name="line.64"></a>
<FONT color="green">065</FONT> public static boolean isEmpty(Map m) {<a name="line.65"></a>
<FONT color="green">066</FONT> return m == null || m.isEmpty();<a name="line.66"></a>
<FONT color="green">067</FONT> }<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> /**<a name="line.69"></a>
<FONT color="green">070</FONT> * Returns the size of the specified collection or {@code 0} if the collection is {@code null}.<a name="line.70"></a>
<FONT color="green">071</FONT> *<a name="line.71"></a>
<FONT color="green">072</FONT> * @param c the collection to check<a name="line.72"></a>
<FONT color="green">073</FONT> * @return the size of the specified collection or {@code 0} if the collection is {@code null}.<a name="line.73"></a>
<FONT color="green">074</FONT> * @since 1.2<a name="line.74"></a>
<FONT color="green">075</FONT> */<a name="line.75"></a>
<FONT color="green">076</FONT> public static int size(Collection c) {<a name="line.76"></a>
<FONT color="green">077</FONT> return c != null ? c.size() : 0;<a name="line.77"></a>
<FONT color="green">078</FONT> }<a name="line.78"></a>
<FONT color="green">079</FONT> <a name="line.79"></a>
<FONT color="green">080</FONT> /**<a name="line.80"></a>
<FONT color="green">081</FONT> * Returns the size of the specified map or {@code 0} if the map is {@code null}.<a name="line.81"></a>
<FONT color="green">082</FONT> *<a name="line.82"></a>
<FONT color="green">083</FONT> * @param m the map to check<a name="line.83"></a>
<FONT color="green">084</FONT> * @return the size of the specified map or {@code 0} if the map is {@code null}.<a name="line.84"></a>
<FONT color="green">085</FONT> * @since 1.2<a name="line.85"></a>
<FONT color="green">086</FONT> */<a name="line.86"></a>
<FONT color="green">087</FONT> public static int size(Map m) {<a name="line.87"></a>
<FONT color="green">088</FONT> return m != null ? m.size() : 0;<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> <a name="line.90"></a>
<FONT color="green">091</FONT> <a name="line.91"></a>
<FONT color="green">092</FONT> /**<a name="line.92"></a>
<FONT color="green">093</FONT> * Returns {@code true} if the specified {@code PrincipalCollection} is {@code null} or<a name="line.93"></a>
<FONT color="green">094</FONT> * {@link PrincipalCollection#isEmpty empty}, {@code false} otherwise.<a name="line.94"></a>
<FONT color="green">095</FONT> *<a name="line.95"></a>
<FONT color="green">096</FONT> * @param principals the principals to check.<a name="line.96"></a>
<FONT color="green">097</FONT> * @return {@code true} if the specified {@code PrincipalCollection} is {@code null} or<a name="line.97"></a>
<FONT color="green">098</FONT> * {@link PrincipalCollection#isEmpty empty}, {@code false} otherwise.<a name="line.98"></a>
<FONT color="green">099</FONT> * @since 1.0<a name="line.99"></a>
<FONT color="green">100</FONT> */<a name="line.100"></a>
<FONT color="green">101</FONT> public static boolean isEmpty(PrincipalCollection principals) {<a name="line.101"></a>
<FONT color="green">102</FONT> return principals == null || principals.isEmpty();<a name="line.102"></a>
<FONT color="green">103</FONT> }<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> public static &lt;E&gt; List&lt;E&gt; asList(E... elements) {<a name="line.105"></a>
<FONT color="green">106</FONT> if (elements == null || elements.length == 0) {<a name="line.106"></a>
<FONT color="green">107</FONT> return Collections.emptyList();<a name="line.107"></a>
<FONT color="green">108</FONT> }<a name="line.108"></a>
<FONT color="green">109</FONT> // Avoid integer overflow when a large array is passed in<a name="line.109"></a>
<FONT color="green">110</FONT> int capacity = computeListCapacity(elements.length);<a name="line.110"></a>
<FONT color="green">111</FONT> ArrayList&lt;E&gt; list = new ArrayList&lt;E&gt;(capacity);<a name="line.111"></a>
<FONT color="green">112</FONT> Collections.addAll(list, elements);<a name="line.112"></a>
<FONT color="green">113</FONT> return list;<a name="line.113"></a>
<FONT color="green">114</FONT> }<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> /*public static &lt;E&gt; Deque&lt;E&gt; asDeque(E... elements) {<a name="line.116"></a>
<FONT color="green">117</FONT> if (elements == null || elements.length == 0) {<a name="line.117"></a>
<FONT color="green">118</FONT> return new ArrayDeque&lt;E&gt;();<a name="line.118"></a>
<FONT color="green">119</FONT> }<a name="line.119"></a>
<FONT color="green">120</FONT> // Avoid integer overflow when a large array is passed in<a name="line.120"></a>
<FONT color="green">121</FONT> int capacity = computeListCapacity(elements.length);<a name="line.121"></a>
<FONT color="green">122</FONT> ArrayDeque&lt;E&gt; deque = new ArrayDeque&lt;E&gt;(capacity);<a name="line.122"></a>
<FONT color="green">123</FONT> Collections.addAll(deque, elements);<a name="line.123"></a>
<FONT color="green">124</FONT> return deque;<a name="line.124"></a>
<FONT color="green">125</FONT> }*/<a name="line.125"></a>
<FONT color="green">126</FONT> <a name="line.126"></a>
<FONT color="green">127</FONT> static int computeListCapacity(int arraySize) {<a name="line.127"></a>
<FONT color="green">128</FONT> return (int) Math.min(5L + arraySize + (arraySize / 10), Integer.MAX_VALUE);<a name="line.128"></a>
<FONT color="green">129</FONT> }<a name="line.129"></a>
<FONT color="green">130</FONT> }<a name="line.130"></a>
</PRE>
</BODY>
</HTML>