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