| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="fr"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> */<a name="line.18"></a> |
| <span class="sourceLineNo">019</span>package org.apache.shiro.util;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Collection;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.util.Map;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span><a name="line.23"></a> |
| <span class="sourceLineNo">024</span>/**<a name="line.24"></a> |
| <span class="sourceLineNo">025</span> * Assertion utility class that assists in validating arguments.<a name="line.25"></a> |
| <span class="sourceLineNo">026</span> * Useful for identifying programmer errors early and clearly at runtime.<a name="line.26"></a> |
| <span class="sourceLineNo">027</span> * Usage also reduces a program's<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <a href="http://en.wikipedia.org/wiki/Cyclomatic_complexity">cyclomatic complexity</a>.<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> *<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * <p>For example, if the contract of a public method states it does not<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * allow <code>null</code> arguments, Assert can be used to validate that<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * contract. Doing this clearly indicates a contract violation when it<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * occurs and protects the class's invariants.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * <p>Typically used to validate method arguments rather than configuration<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * properties, to check for cases that are usually programmer errors rather than<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * configuration errors. In contrast to config initialization code, there is<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * usally no point in falling back to defaults in such methods.<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * <p>This class is similar to JUnit's assertion library. If an argument value is<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * deemed invalid, an {@link IllegalArgumentException} is thrown (typically).<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * For example:<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> *<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * <pre class="code"><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * Assert.notNull(clazz, "The class must not be null");<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * Assert.isTrue(i > 0, "The value must be greater than zero");</pre><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> *<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> * Mainly for internal use within the framework; consider Jakarta's Commons Lang<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * >= 2.0 for a more comprehensive suite of assertion utilities.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * <p/><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * <em>Gratefully borrowed from the Spring Framework, also Apache 2.0 licensed</em><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> *<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * @author Keith Donald<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @author Juergen Hoeller<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * @author Colin Sampaleanu<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @author Rob Harrop<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @since 1.3<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span>public abstract class Assert {<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Assert a boolean expression, throwing <code>IllegalArgumentException</code><a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * if the test result is <code>false</code>.<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <pre class="code">Assert.isTrue(i &gt; 0, "The value must be greater than zero");</pre><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @param expression a boolean expression<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param message the exception message to use if the assertion fails<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @throws IllegalArgumentException if expression is <code>false</code><a name="line.67"></a> |
| <span class="sourceLineNo">068</span> */<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> public static void isTrue(boolean expression, String message) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> if (!expression) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> throw new IllegalArgumentException(message);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> }<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Assert a boolean expression, throwing <code>IllegalArgumentException</code><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * if the test result is <code>false</code>.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * <pre class="code">Assert.isTrue(i &gt; 0);</pre><a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param expression a boolean expression<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @throws IllegalArgumentException if expression is <code>false</code><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> */<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> public static void isTrue(boolean expression) {<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> isTrue(expression, "[Assertion failed] - this expression must be true");<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> }<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Assert that an object is <code>null</code> .<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <pre class="code">Assert.isNull(value, "The value must be null");</pre><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * @param object the object to check<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> * @param message the exception message to use if the assertion fails<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @throws IllegalArgumentException if the object is not <code>null</code><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> public static void isNull(Object object, String message) {<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> if (object != null) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> throw new IllegalArgumentException(message);<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> }<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> }<a name="line.97"></a> |
| <span class="sourceLineNo">098</span><a name="line.98"></a> |
| <span class="sourceLineNo">099</span> /**<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * Assert that an object is <code>null</code> .<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * <pre class="code">Assert.isNull(value);</pre><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @param object the object to check<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @throws IllegalArgumentException if the object is not <code>null</code><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public static void isNull(Object object) {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> isNull(object, "[Assertion failed] - the object argument must be null");<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> /**<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * Assert that an object is not <code>null</code> .<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * <pre class="code">Assert.notNull(clazz, "The class must not be null");</pre><a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @param object the object to check<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * @param message the exception message to use if the assertion fails<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @throws IllegalArgumentException if the object is <code>null</code><a name="line.114"></a> |
| <span class="sourceLineNo">115</span> */<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> public static void notNull(Object object, String message) {<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> if (object == null) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> throw new IllegalArgumentException(message);<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span><a name="line.121"></a> |
| <span class="sourceLineNo">122</span> /**<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * Assert that an object is not <code>null</code> .<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * <pre class="code">Assert.notNull(clazz);</pre><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @param object the object to check<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * @throws IllegalArgumentException if the object is <code>null</code><a name="line.126"></a> |
| <span class="sourceLineNo">127</span> */<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> public static void notNull(Object object) {<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> notNull(object, "[Assertion failed] - this argument is required; it must not be null");<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> }<a name="line.130"></a> |
| <span class="sourceLineNo">131</span><a name="line.131"></a> |
| <span class="sourceLineNo">132</span> /**<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * Assert that the given String is not empty; that is,<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * it must not be <code>null</code> and not the empty String.<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * <pre class="code">Assert.hasLength(name, "Name must not be empty");</pre><a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * @param text the String to check<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param message the exception message to use if the assertion fails<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @see StringUtils#hasLength<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> public static void hasLength(String text, String message) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> if (!StringUtils.hasLength(text)) {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> throw new IllegalArgumentException(message);<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> }<a name="line.144"></a> |
| <span class="sourceLineNo">145</span><a name="line.145"></a> |
| <span class="sourceLineNo">146</span> /**<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> * Assert that the given String is not empty; that is,<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> * it must not be <code>null</code> and not the empty String.<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> * <pre class="code">Assert.hasLength(name);</pre><a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * @param text the String to check<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> * @see StringUtils#hasLength<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> */<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public static void hasLength(String text) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> hasLength(text,<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> "[Assertion failed] - this String argument must have length; it must not be null or empty");<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> /**<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> * Assert that the given String has valid text content; that is, it must not<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> * be <code>null</code> and must contain at least one non-whitespace character.<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> * <pre class="code">Assert.hasText(name, "'name' must not be empty");</pre><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> * @param text the String to check<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * @param message the exception message to use if the assertion fails<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> * @see StringUtils#hasText<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> */<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> public static void hasText(String text, String message) {<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> if (!StringUtils.hasText(text)) {<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> throw new IllegalArgumentException(message);<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> }<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> }<a name="line.170"></a> |
| <span class="sourceLineNo">171</span><a name="line.171"></a> |
| <span class="sourceLineNo">172</span> /**<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * Assert that the given String has valid text content; that is, it must not<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> * be <code>null</code> and must contain at least one non-whitespace character.<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> * <pre class="code">Assert.hasText(name, "'name' must not be empty");</pre><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> * @param text the String to check<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> * @see StringUtils#hasText<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> */<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> public static void hasText(String text) {<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> hasText(text,<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> "[Assertion failed] - this String argument must have text; it must not be null, empty, or blank");<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> }<a name="line.182"></a> |
| <span class="sourceLineNo">183</span><a name="line.183"></a> |
| <span class="sourceLineNo">184</span> /**<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * Assert that the given text does not contain the given substring.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * <pre class="code">Assert.doesNotContain(name, "rod", "Name must not contain 'rod'");</pre><a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * @param textToSearch the text to search<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * @param substring the substring to find within the text<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @param message the exception message to use if the assertion fails<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> */<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> public static void doesNotContain(String textToSearch, String substring, String message) {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> if (StringUtils.hasLength(textToSearch) && StringUtils.hasLength(substring) &&<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> textToSearch.indexOf(substring) != -1) {<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> throw new IllegalArgumentException(message);<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> }<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> }<a name="line.196"></a> |
| <span class="sourceLineNo">197</span><a name="line.197"></a> |
| <span class="sourceLineNo">198</span> /**<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> * Assert that the given text does not contain the given substring.<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> * <pre class="code">Assert.doesNotContain(name, "rod");</pre><a name="line.200"></a> |
| <span class="sourceLineNo">201</span> * @param textToSearch the text to search<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> * @param substring the substring to find within the text<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> */<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> public static void doesNotContain(String textToSearch, String substring) {<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> doesNotContain(textToSearch, substring,<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> "[Assertion failed] - this String argument must not contain the substring [" + substring + "]");<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> }<a name="line.207"></a> |
| <span class="sourceLineNo">208</span><a name="line.208"></a> |
| <span class="sourceLineNo">209</span><a name="line.209"></a> |
| <span class="sourceLineNo">210</span> /**<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> * Assert that an array has elements; that is, it must not be<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> * <code>null</code> and must have at least one element.<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> * <pre class="code">Assert.notEmpty(array, "The array must have elements");</pre><a name="line.213"></a> |
| <span class="sourceLineNo">214</span> * @param array the array to check<a name="line.214"></a> |
| <span class="sourceLineNo">215</span> * @param message the exception message to use if the assertion fails<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> * @throws IllegalArgumentException if the object array is <code>null</code> or has no elements<a name="line.216"></a> |
| <span class="sourceLineNo">217</span> */<a name="line.217"></a> |
| <span class="sourceLineNo">218</span> public static void notEmpty(Object[] array, String message) {<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> if (array == null || array.length == 0) {<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> throw new IllegalArgumentException(message);<a name="line.220"></a> |
| <span class="sourceLineNo">221</span> }<a name="line.221"></a> |
| <span class="sourceLineNo">222</span> }<a name="line.222"></a> |
| <span class="sourceLineNo">223</span><a name="line.223"></a> |
| <span class="sourceLineNo">224</span> /**<a name="line.224"></a> |
| <span class="sourceLineNo">225</span> * Assert that an array has elements; that is, it must not be<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> * <code>null</code> and must have at least one element.<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> * <pre class="code">Assert.notEmpty(array);</pre><a name="line.227"></a> |
| <span class="sourceLineNo">228</span> * @param array the array to check<a name="line.228"></a> |
| <span class="sourceLineNo">229</span> * @throws IllegalArgumentException if the object array is <code>null</code> or has no elements<a name="line.229"></a> |
| <span class="sourceLineNo">230</span> */<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> public static void notEmpty(Object[] array) {<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> notEmpty(array, "[Assertion failed] - this array must not be empty: it must contain at least 1 element");<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> }<a name="line.233"></a> |
| <span class="sourceLineNo">234</span><a name="line.234"></a> |
| <span class="sourceLineNo">235</span> /**<a name="line.235"></a> |
| <span class="sourceLineNo">236</span> * Assert that an array has no null elements.<a name="line.236"></a> |
| <span class="sourceLineNo">237</span> * Note: Does not complain if the array is empty!<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> * <pre class="code">Assert.noNullElements(array, "The array must have non-null elements");</pre><a name="line.238"></a> |
| <span class="sourceLineNo">239</span> * @param array the array to check<a name="line.239"></a> |
| <span class="sourceLineNo">240</span> * @param message the exception message to use if the assertion fails<a name="line.240"></a> |
| <span class="sourceLineNo">241</span> * @throws IllegalArgumentException if the object array contains a <code>null</code> element<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> */<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> public static void noNullElements(Object[] array, String message) {<a name="line.243"></a> |
| <span class="sourceLineNo">244</span> if (array != null) {<a name="line.244"></a> |
| <span class="sourceLineNo">245</span> for (int i = 0; i < array.length; i++) {<a name="line.245"></a> |
| <span class="sourceLineNo">246</span> if (array[i] == null) {<a name="line.246"></a> |
| <span class="sourceLineNo">247</span> throw new IllegalArgumentException(message);<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> }<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> }<a name="line.249"></a> |
| <span class="sourceLineNo">250</span> }<a name="line.250"></a> |
| <span class="sourceLineNo">251</span> }<a name="line.251"></a> |
| <span class="sourceLineNo">252</span><a name="line.252"></a> |
| <span class="sourceLineNo">253</span> /**<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> * Assert that an array has no null elements.<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> * Note: Does not complain if the array is empty!<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> * <pre class="code">Assert.noNullElements(array);</pre><a name="line.256"></a> |
| <span class="sourceLineNo">257</span> * @param array the array to check<a name="line.257"></a> |
| <span class="sourceLineNo">258</span> * @throws IllegalArgumentException if the object array contains a <code>null</code> element<a name="line.258"></a> |
| <span class="sourceLineNo">259</span> */<a name="line.259"></a> |
| <span class="sourceLineNo">260</span> public static void noNullElements(Object[] array) {<a name="line.260"></a> |
| <span class="sourceLineNo">261</span> noNullElements(array, "[Assertion failed] - this array must not contain any null elements");<a name="line.261"></a> |
| <span class="sourceLineNo">262</span> }<a name="line.262"></a> |
| <span class="sourceLineNo">263</span><a name="line.263"></a> |
| <span class="sourceLineNo">264</span> /**<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> * Assert that a collection has elements; that is, it must not be<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> * <code>null</code> and must have at least one element.<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> * <pre class="code">Assert.notEmpty(collection, "Collection must have elements");</pre><a name="line.267"></a> |
| <span class="sourceLineNo">268</span> * @param collection the collection to check<a name="line.268"></a> |
| <span class="sourceLineNo">269</span> * @param message the exception message to use if the assertion fails<a name="line.269"></a> |
| <span class="sourceLineNo">270</span> * @throws IllegalArgumentException if the collection is <code>null</code> or has no elements<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> */<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> public static void notEmpty(Collection collection, String message) {<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> if (isEmpty(collection)) {<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> throw new IllegalArgumentException(message);<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> }<a name="line.275"></a> |
| <span class="sourceLineNo">276</span> }<a name="line.276"></a> |
| <span class="sourceLineNo">277</span><a name="line.277"></a> |
| <span class="sourceLineNo">278</span> /**<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> * Assert that a collection has elements; that is, it must not be<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> * <code>null</code> and must have at least one element.<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> * <pre class="code">Assert.notEmpty(collection, "Collection must have elements");</pre><a name="line.281"></a> |
| <span class="sourceLineNo">282</span> * @param collection the collection to check<a name="line.282"></a> |
| <span class="sourceLineNo">283</span> * @throws IllegalArgumentException if the collection is <code>null</code> or has no elements<a name="line.283"></a> |
| <span class="sourceLineNo">284</span> */<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> public static void notEmpty(Collection collection) {<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> notEmpty(collection,<a name="line.286"></a> |
| <span class="sourceLineNo">287</span> "[Assertion failed] - this collection must not be empty: it must contain at least 1 element");<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> }<a name="line.288"></a> |
| <span class="sourceLineNo">289</span><a name="line.289"></a> |
| <span class="sourceLineNo">290</span> /**<a name="line.290"></a> |
| <span class="sourceLineNo">291</span> * Assert that a Map has entries; that is, it must not be <code>null</code><a name="line.291"></a> |
| <span class="sourceLineNo">292</span> * and must have at least one entry.<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> * <pre class="code">Assert.notEmpty(map, "Map must have entries");</pre><a name="line.293"></a> |
| <span class="sourceLineNo">294</span> * @param map the map to check<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> * @param message the exception message to use if the assertion fails<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> * @throws IllegalArgumentException if the map is <code>null</code> or has no entries<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> */<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> public static void notEmpty(Map map, String message) {<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> if (isEmpty(map)) {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> throw new IllegalArgumentException(message);<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> }<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> }<a name="line.302"></a> |
| <span class="sourceLineNo">303</span><a name="line.303"></a> |
| <span class="sourceLineNo">304</span> /**<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> * Assert that a Map has entries; that is, it must not be <code>null</code><a name="line.305"></a> |
| <span class="sourceLineNo">306</span> * and must have at least one entry.<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> * <pre class="code">Assert.notEmpty(map);</pre><a name="line.307"></a> |
| <span class="sourceLineNo">308</span> * @param map the map to check<a name="line.308"></a> |
| <span class="sourceLineNo">309</span> * @throws IllegalArgumentException if the map is <code>null</code> or has no entries<a name="line.309"></a> |
| <span class="sourceLineNo">310</span> */<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> public static void notEmpty(Map map) {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> notEmpty(map, "[Assertion failed] - this map must not be empty; it must contain at least one entry");<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> }<a name="line.313"></a> |
| <span class="sourceLineNo">314</span><a name="line.314"></a> |
| <span class="sourceLineNo">315</span><a name="line.315"></a> |
| <span class="sourceLineNo">316</span> /**<a name="line.316"></a> |
| <span class="sourceLineNo">317</span> * Assert that the provided object is an instance of the provided class.<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> * <pre class="code">Assert.instanceOf(Foo.class, foo);</pre><a name="line.318"></a> |
| <span class="sourceLineNo">319</span> * @param clazz the required class<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> * @param obj the object to check<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> * @throws IllegalArgumentException if the object is not an instance of clazz<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> * @see Class#isInstance<a name="line.322"></a> |
| <span class="sourceLineNo">323</span> */<a name="line.323"></a> |
| <span class="sourceLineNo">324</span> public static void isInstanceOf(Class clazz, Object obj) {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> isInstanceOf(clazz, obj, "");<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> }<a name="line.326"></a> |
| <span class="sourceLineNo">327</span><a name="line.327"></a> |
| <span class="sourceLineNo">328</span> /**<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> * Assert that the provided object is an instance of the provided class.<a name="line.329"></a> |
| <span class="sourceLineNo">330</span> * <pre class="code">Assert.instanceOf(Foo.class, foo);</pre><a name="line.330"></a> |
| <span class="sourceLineNo">331</span> * @param type the type to check against<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * @param obj the object to check<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> * @param message a message which will be prepended to the message produced by<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * the function itself, and which may be used to provide context. It should<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * normally end in a ": " or ". " so that the function generate message looks<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * ok when prepended to it.<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * @throws IllegalArgumentException if the object is not an instance of clazz<a name="line.337"></a> |
| <span class="sourceLineNo">338</span> * @see Class#isInstance<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> */<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> public static void isInstanceOf(Class type, Object obj, String message) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> notNull(type, "Type to check against must not be null");<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> if (!type.isInstance(obj)) {<a name="line.342"></a> |
| <span class="sourceLineNo">343</span> throw new IllegalArgumentException(message +<a name="line.343"></a> |
| <span class="sourceLineNo">344</span> "Object of class [" + (obj != null ? obj.getClass().getName() : "null") +<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> "] must be an instance of " + type);<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> }<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> }<a name="line.347"></a> |
| <span class="sourceLineNo">348</span><a name="line.348"></a> |
| <span class="sourceLineNo">349</span> /**<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * Assert that <code>superType.isAssignableFrom(subType)</code> is <code>true</code>.<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> * <pre class="code">Assert.isAssignable(Number.class, myClass);</pre><a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * @param superType the super type to check<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * @param subType the sub type to check<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> * @throws IllegalArgumentException if the classes are not assignable<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> */<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> public static void isAssignable(Class superType, Class subType) {<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> isAssignable(superType, subType, "");<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> }<a name="line.358"></a> |
| <span class="sourceLineNo">359</span><a name="line.359"></a> |
| <span class="sourceLineNo">360</span> /**<a name="line.360"></a> |
| <span class="sourceLineNo">361</span> * Assert that <code>superType.isAssignableFrom(subType)</code> is <code>true</code>.<a name="line.361"></a> |
| <span class="sourceLineNo">362</span> * <pre class="code">Assert.isAssignable(Number.class, myClass);</pre><a name="line.362"></a> |
| <span class="sourceLineNo">363</span> * @param superType the super type to check against<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> * @param subType the sub type to check<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> * @param message a message which will be prepended to the message produced by<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> * the function itself, and which may be used to provide context. It should<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> * normally end in a ": " or ". " so that the function generate message looks<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> * ok when prepended to it.<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> * @throws IllegalArgumentException if the classes are not assignable<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> */<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> public static void isAssignable(Class superType, Class subType, String message) {<a name="line.371"></a> |
| <span class="sourceLineNo">372</span> notNull(superType, "Type to check against must not be null");<a name="line.372"></a> |
| <span class="sourceLineNo">373</span> if (subType == null || !superType.isAssignableFrom(subType)) {<a name="line.373"></a> |
| <span class="sourceLineNo">374</span> throw new IllegalArgumentException(message + subType + " is not assignable to " + superType);<a name="line.374"></a> |
| <span class="sourceLineNo">375</span> }<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> }<a name="line.376"></a> |
| <span class="sourceLineNo">377</span><a name="line.377"></a> |
| <span class="sourceLineNo">378</span><a name="line.378"></a> |
| <span class="sourceLineNo">379</span> /**<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> * Assert a boolean expression, throwing <code>IllegalStateException</code><a name="line.380"></a> |
| <span class="sourceLineNo">381</span> * if the test result is <code>false</code>. Call isTrue if you wish to<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> * throw IllegalArgumentException on an assertion failure.<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> * <pre class="code">Assert.state(id == null, "The id property must not already be initialized");</pre><a name="line.383"></a> |
| <span class="sourceLineNo">384</span> * @param expression a boolean expression<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> * @param message the exception message to use if the assertion fails<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> * @throws IllegalStateException if expression is <code>false</code><a name="line.386"></a> |
| <span class="sourceLineNo">387</span> */<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> public static void state(boolean expression, String message) {<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> if (!expression) {<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> throw new IllegalStateException(message);<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> }<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> }<a name="line.392"></a> |
| <span class="sourceLineNo">393</span><a name="line.393"></a> |
| <span class="sourceLineNo">394</span> /**<a name="line.394"></a> |
| <span class="sourceLineNo">395</span> * Assert a boolean expression, throwing {@link IllegalStateException}<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> * if the test result is <code>false</code>.<a name="line.396"></a> |
| <span class="sourceLineNo">397</span> * <p>Call {@link #isTrue(boolean)} if you wish to<a name="line.397"></a> |
| <span class="sourceLineNo">398</span> * throw {@link IllegalArgumentException} on an assertion failure.<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * <pre class="code">Assert.state(id == null);</pre><a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * @param expression a boolean expression<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> * @throws IllegalStateException if the supplied expression is <code>false</code><a name="line.401"></a> |
| <span class="sourceLineNo">402</span> */<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> public static void state(boolean expression) {<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> state(expression, "[Assertion failed] - this state invariant must be true");<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> }<a name="line.405"></a> |
| <span class="sourceLineNo">406</span><a name="line.406"></a> |
| <span class="sourceLineNo">407</span><a name="line.407"></a> |
| <span class="sourceLineNo">408</span> //////////////////////////<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> // From CollectionUtils //<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> //////////////////////////<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> // CollectionUtils cannot be removed from shiro-core until 2.0 as it has a dependency on PrincipalCollection<a name="line.411"></a> |
| <span class="sourceLineNo">412</span><a name="line.412"></a> |
| <span class="sourceLineNo">413</span> private static boolean isEmpty(Map m) {<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> return m == null || m.isEmpty();<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> }<a name="line.415"></a> |
| <span class="sourceLineNo">416</span><a name="line.416"></a> |
| <span class="sourceLineNo">417</span> private static boolean isEmpty(Collection c) {<a name="line.417"></a> |
| <span class="sourceLineNo">418</span> return c == null || c.isEmpty();<a name="line.418"></a> |
| <span class="sourceLineNo">419</span> }<a name="line.419"></a> |
| <span class="sourceLineNo">420</span><a name="line.420"></a> |
| <span class="sourceLineNo">421</span>}<a name="line.421"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
