Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.6.0 / apidocs / src-html / org / apache / shiro / web / filter / mgt / SimpleNamedFilterList.html
blob: e7aa9fabc9210eb2496d974c6ffe304699deea0d [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<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.web.filter.mgt;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.util.StringUtils;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.web.servlet.ProxiedFilterChain;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">import javax.servlet.Filter;</a>
<span class="sourceLineNo">025</span><a id="line.25">import javax.servlet.FilterChain;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.util.*;</a>
<span class="sourceLineNo">027</span><a id="line.27"></a>
<span class="sourceLineNo">028</span><a id="line.28">/**</a>
<span class="sourceLineNo">029</span><a id="line.29"> * Simple {@code NamedFilterList} implementation that is supported by a backing {@link List} instance and a simple</a>
<span class="sourceLineNo">030</span><a id="line.30"> * {@link #getName() name} property. All {@link List} method implementations are immediately delegated to the</a>
<span class="sourceLineNo">031</span><a id="line.31"> * wrapped backing list.</a>
<span class="sourceLineNo">032</span><a id="line.32"> *</a>
<span class="sourceLineNo">033</span><a id="line.33"> * @since 1.0</a>
<span class="sourceLineNo">034</span><a id="line.34"> */</a>
<span class="sourceLineNo">035</span><a id="line.35">public class SimpleNamedFilterList implements NamedFilterList {</a>
<span class="sourceLineNo">036</span><a id="line.36"></a>
<span class="sourceLineNo">037</span><a id="line.37"> private String name;</a>
<span class="sourceLineNo">038</span><a id="line.38"> private List&lt;Filter&gt; backingList;</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> /**</a>
<span class="sourceLineNo">041</span><a id="line.41"> * Creates a new {@code SimpleNamedFilterList} instance with the specified {@code name}, defaulting to a new</a>
<span class="sourceLineNo">042</span><a id="line.42"> * {@link ArrayList ArrayList} instance as the backing list.</a>
<span class="sourceLineNo">043</span><a id="line.43"> *</a>
<span class="sourceLineNo">044</span><a id="line.44"> * @param name the name to assign to this instance.</a>
<span class="sourceLineNo">045</span><a id="line.45"> * @throws IllegalArgumentException if {@code name} is null or empty.</a>
<span class="sourceLineNo">046</span><a id="line.46"> */</a>
<span class="sourceLineNo">047</span><a id="line.47"> public SimpleNamedFilterList(String name) {</a>
<span class="sourceLineNo">048</span><a id="line.48"> this(name, new ArrayList&lt;Filter&gt;());</a>
<span class="sourceLineNo">049</span><a id="line.49"> }</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> /**</a>
<span class="sourceLineNo">052</span><a id="line.52"> * Creates a new {@code SimpleNamedFilterList} instance with the specified {@code name} and {@code backingList}.</a>
<span class="sourceLineNo">053</span><a id="line.53"> *</a>
<span class="sourceLineNo">054</span><a id="line.54"> * @param name the name to assign to this instance.</a>
<span class="sourceLineNo">055</span><a id="line.55"> * @param backingList the list instance used to back all of this class's {@link List} method implementations.</a>
<span class="sourceLineNo">056</span><a id="line.56"> * @throws IllegalArgumentException if {@code name} is null or empty.</a>
<span class="sourceLineNo">057</span><a id="line.57"> * @throws NullPointerException if the backing list is {@code null}.</a>
<span class="sourceLineNo">058</span><a id="line.58"> */</a>
<span class="sourceLineNo">059</span><a id="line.59"> public SimpleNamedFilterList(String name, List&lt;Filter&gt; backingList) {</a>
<span class="sourceLineNo">060</span><a id="line.60"> if (backingList == null) {</a>
<span class="sourceLineNo">061</span><a id="line.61"> throw new NullPointerException("backingList constructor argument cannot be null.");</a>
<span class="sourceLineNo">062</span><a id="line.62"> }</a>
<span class="sourceLineNo">063</span><a id="line.63"> this.backingList = backingList;</a>
<span class="sourceLineNo">064</span><a id="line.64"> setName(name);</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"> protected void setName(String name) {</a>
<span class="sourceLineNo">068</span><a id="line.68"> if (!StringUtils.hasText(name)) {</a>
<span class="sourceLineNo">069</span><a id="line.69"> throw new IllegalArgumentException("Cannot specify a null or empty name.");</a>
<span class="sourceLineNo">070</span><a id="line.70"> }</a>
<span class="sourceLineNo">071</span><a id="line.71"> this.name = name;</a>
<span class="sourceLineNo">072</span><a id="line.72"> }</a>
<span class="sourceLineNo">073</span><a id="line.73"></a>
<span class="sourceLineNo">074</span><a id="line.74"> public String getName() {</a>
<span class="sourceLineNo">075</span><a id="line.75"> return name;</a>
<span class="sourceLineNo">076</span><a id="line.76"> }</a>
<span class="sourceLineNo">077</span><a id="line.77"></a>
<span class="sourceLineNo">078</span><a id="line.78"> public FilterChain proxy(FilterChain orig) {</a>
<span class="sourceLineNo">079</span><a id="line.79"> return new ProxiedFilterChain(orig, this);</a>
<span class="sourceLineNo">080</span><a id="line.80"> }</a>
<span class="sourceLineNo">081</span><a id="line.81"></a>
<span class="sourceLineNo">082</span><a id="line.82"> public boolean add(Filter filter) {</a>
<span class="sourceLineNo">083</span><a id="line.83"> return this.backingList.add(filter);</a>
<span class="sourceLineNo">084</span><a id="line.84"> }</a>
<span class="sourceLineNo">085</span><a id="line.85"></a>
<span class="sourceLineNo">086</span><a id="line.86"> public void add(int index, Filter filter) {</a>
<span class="sourceLineNo">087</span><a id="line.87"> this.backingList.add(index, filter);</a>
<span class="sourceLineNo">088</span><a id="line.88"> }</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"> public boolean addAll(Collection&lt;? extends Filter&gt; c) {</a>
<span class="sourceLineNo">091</span><a id="line.91"> return this.backingList.addAll(c);</a>
<span class="sourceLineNo">092</span><a id="line.92"> }</a>
<span class="sourceLineNo">093</span><a id="line.93"></a>
<span class="sourceLineNo">094</span><a id="line.94"> public boolean addAll(int index, Collection&lt;? extends Filter&gt; c) {</a>
<span class="sourceLineNo">095</span><a id="line.95"> return this.backingList.addAll(index, c);</a>
<span class="sourceLineNo">096</span><a id="line.96"> }</a>
<span class="sourceLineNo">097</span><a id="line.97"></a>
<span class="sourceLineNo">098</span><a id="line.98"> public void clear() {</a>
<span class="sourceLineNo">099</span><a id="line.99"> this.backingList.clear();</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"> public boolean contains(Object o) {</a>
<span class="sourceLineNo">103</span><a id="line.103"> return this.backingList.contains(o);</a>
<span class="sourceLineNo">104</span><a id="line.104"> }</a>
<span class="sourceLineNo">105</span><a id="line.105"></a>
<span class="sourceLineNo">106</span><a id="line.106"> public boolean containsAll(Collection&lt;?&gt; c) {</a>
<span class="sourceLineNo">107</span><a id="line.107"> return this.backingList.containsAll(c);</a>
<span class="sourceLineNo">108</span><a id="line.108"> }</a>
<span class="sourceLineNo">109</span><a id="line.109"></a>
<span class="sourceLineNo">110</span><a id="line.110"> public Filter get(int index) {</a>
<span class="sourceLineNo">111</span><a id="line.111"> return this.backingList.get(index);</a>
<span class="sourceLineNo">112</span><a id="line.112"> }</a>
<span class="sourceLineNo">113</span><a id="line.113"></a>
<span class="sourceLineNo">114</span><a id="line.114"> public int indexOf(Object o) {</a>
<span class="sourceLineNo">115</span><a id="line.115"> return this.backingList.indexOf(o);</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 boolean isEmpty() {</a>
<span class="sourceLineNo">119</span><a id="line.119"> return this.backingList.isEmpty();</a>
<span class="sourceLineNo">120</span><a id="line.120"> }</a>
<span class="sourceLineNo">121</span><a id="line.121"></a>
<span class="sourceLineNo">122</span><a id="line.122"> public Iterator&lt;Filter&gt; iterator() {</a>
<span class="sourceLineNo">123</span><a id="line.123"> return this.backingList.iterator();</a>
<span class="sourceLineNo">124</span><a id="line.124"> }</a>
<span class="sourceLineNo">125</span><a id="line.125"></a>
<span class="sourceLineNo">126</span><a id="line.126"> public int lastIndexOf(Object o) {</a>
<span class="sourceLineNo">127</span><a id="line.127"> return this.backingList.lastIndexOf(o);</a>
<span class="sourceLineNo">128</span><a id="line.128"> }</a>
<span class="sourceLineNo">129</span><a id="line.129"></a>
<span class="sourceLineNo">130</span><a id="line.130"> public ListIterator&lt;Filter&gt; listIterator() {</a>
<span class="sourceLineNo">131</span><a id="line.131"> return this.backingList.listIterator();</a>
<span class="sourceLineNo">132</span><a id="line.132"> }</a>
<span class="sourceLineNo">133</span><a id="line.133"></a>
<span class="sourceLineNo">134</span><a id="line.134"> public ListIterator&lt;Filter&gt; listIterator(int index) {</a>
<span class="sourceLineNo">135</span><a id="line.135"> return this.backingList.listIterator(index);</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"> public Filter remove(int index) {</a>
<span class="sourceLineNo">139</span><a id="line.139"> return this.backingList.remove(index);</a>
<span class="sourceLineNo">140</span><a id="line.140"> }</a>
<span class="sourceLineNo">141</span><a id="line.141"></a>
<span class="sourceLineNo">142</span><a id="line.142"> public boolean remove(Object o) {</a>
<span class="sourceLineNo">143</span><a id="line.143"> return this.backingList.remove(o);</a>
<span class="sourceLineNo">144</span><a id="line.144"> }</a>
<span class="sourceLineNo">145</span><a id="line.145"></a>
<span class="sourceLineNo">146</span><a id="line.146"> public boolean removeAll(Collection&lt;?&gt; c) {</a>
<span class="sourceLineNo">147</span><a id="line.147"> return this.backingList.removeAll(c);</a>
<span class="sourceLineNo">148</span><a id="line.148"> }</a>
<span class="sourceLineNo">149</span><a id="line.149"></a>
<span class="sourceLineNo">150</span><a id="line.150"> public boolean retainAll(Collection&lt;?&gt; c) {</a>
<span class="sourceLineNo">151</span><a id="line.151"> return this.backingList.retainAll(c);</a>
<span class="sourceLineNo">152</span><a id="line.152"> }</a>
<span class="sourceLineNo">153</span><a id="line.153"></a>
<span class="sourceLineNo">154</span><a id="line.154"> public Filter set(int index, Filter filter) {</a>
<span class="sourceLineNo">155</span><a id="line.155"> return this.backingList.set(index, filter);</a>
<span class="sourceLineNo">156</span><a id="line.156"> }</a>
<span class="sourceLineNo">157</span><a id="line.157"></a>
<span class="sourceLineNo">158</span><a id="line.158"> public int size() {</a>
<span class="sourceLineNo">159</span><a id="line.159"> return this.backingList.size();</a>
<span class="sourceLineNo">160</span><a id="line.160"> }</a>
<span class="sourceLineNo">161</span><a id="line.161"></a>
<span class="sourceLineNo">162</span><a id="line.162"> public List&lt;Filter&gt; subList(int fromIndex, int toIndex) {</a>
<span class="sourceLineNo">163</span><a id="line.163"> return this.backingList.subList(fromIndex, toIndex);</a>
<span class="sourceLineNo">164</span><a id="line.164"> }</a>
<span class="sourceLineNo">165</span><a id="line.165"></a>
<span class="sourceLineNo">166</span><a id="line.166"> public Object[] toArray() {</a>
<span class="sourceLineNo">167</span><a id="line.167"> return this.backingList.toArray();</a>
<span class="sourceLineNo">168</span><a id="line.168"> }</a>
<span class="sourceLineNo">169</span><a id="line.169"></a>
<span class="sourceLineNo">170</span><a id="line.170"> public &lt;T&gt; T[] toArray(T[] a) {</a>
<span class="sourceLineNo">171</span><a id="line.171"> //noinspection SuspiciousToArrayCall</a>
<span class="sourceLineNo">172</span><a id="line.172"> return this.backingList.toArray(a);</a>
<span class="sourceLineNo">173</span><a id="line.173"> }</a>
<span class="sourceLineNo">174</span><a id="line.174">}</a>
</pre>
</div>
</main>
</body>
</html>