Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.8.0 / shiro-core / apidocs / src-html / org / apache / shiro / util / MapContext.html
blob: 320b990ef4cfa24ea02986b8f6bbdcc592fa1ee4 [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.util;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import java.io.Serializable;</a>
<span class="sourceLineNo">022</span><a id="line.22">import java.util.*;</a>
<span class="sourceLineNo">023</span><a id="line.23"></a>
<span class="sourceLineNo">024</span><a id="line.24">/**</a>
<span class="sourceLineNo">025</span><a id="line.25"> * A {@code MapContext} provides a common base for context-based data storage in a {@link Map}. Type-safe attribute</a>
<span class="sourceLineNo">026</span><a id="line.26"> * retrieval is provided for subclasses with the {@link #getTypedValue(String, Class)} method.</a>
<span class="sourceLineNo">027</span><a id="line.27"> *</a>
<span class="sourceLineNo">028</span><a id="line.28"> * @see org.apache.shiro.subject.SubjectContext SubjectContext</a>
<span class="sourceLineNo">029</span><a id="line.29"> * @see org.apache.shiro.session.mgt.SessionContext SessionContext</a>
<span class="sourceLineNo">030</span><a id="line.30"> * @since 1.0</a>
<span class="sourceLineNo">031</span><a id="line.31"> */</a>
<span class="sourceLineNo">032</span><a id="line.32">public class MapContext implements Map&lt;String, Object&gt;, Serializable {</a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34"> private static final long serialVersionUID = 5373399119017820322L;</a>
<span class="sourceLineNo">035</span><a id="line.35"></a>
<span class="sourceLineNo">036</span><a id="line.36"> private final Map&lt;String, Object&gt; backingMap;</a>
<span class="sourceLineNo">037</span><a id="line.37"></a>
<span class="sourceLineNo">038</span><a id="line.38"> public MapContext() {</a>
<span class="sourceLineNo">039</span><a id="line.39"> this.backingMap = new HashMap&lt;String, Object&gt;();</a>
<span class="sourceLineNo">040</span><a id="line.40"> }</a>
<span class="sourceLineNo">041</span><a id="line.41"></a>
<span class="sourceLineNo">042</span><a id="line.42"> public MapContext(Map&lt;String, Object&gt; map) {</a>
<span class="sourceLineNo">043</span><a id="line.43"> this();</a>
<span class="sourceLineNo">044</span><a id="line.44"> if (!CollectionUtils.isEmpty(map)) {</a>
<span class="sourceLineNo">045</span><a id="line.45"> this.backingMap.putAll(map);</a>
<span class="sourceLineNo">046</span><a id="line.46"> }</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"> /**</a>
<span class="sourceLineNo">050</span><a id="line.50"> * Performs a {@link #get get} operation but additionally ensures that the value returned is of the specified</a>
<span class="sourceLineNo">051</span><a id="line.51"> * {@code type}. If there is no value, {@code null} is returned.</a>
<span class="sourceLineNo">052</span><a id="line.52"> *</a>
<span class="sourceLineNo">053</span><a id="line.53"> * @param key the attribute key to look up a value</a>
<span class="sourceLineNo">054</span><a id="line.54"> * @param type the expected type of the value</a>
<span class="sourceLineNo">055</span><a id="line.55"> * @param &lt;E&gt; the expected type of the value</a>
<span class="sourceLineNo">056</span><a id="line.56"> * @return the typed value or {@code null} if the attribute does not exist.</a>
<span class="sourceLineNo">057</span><a id="line.57"> */</a>
<span class="sourceLineNo">058</span><a id="line.58"> @SuppressWarnings({"unchecked"})</a>
<span class="sourceLineNo">059</span><a id="line.59"> protected &lt;E&gt; E getTypedValue(String key, Class&lt;E&gt; type) {</a>
<span class="sourceLineNo">060</span><a id="line.60"> E found = null;</a>
<span class="sourceLineNo">061</span><a id="line.61"> Object o = backingMap.get(key);</a>
<span class="sourceLineNo">062</span><a id="line.62"> if (o != null) {</a>
<span class="sourceLineNo">063</span><a id="line.63"> if (!type.isAssignableFrom(o.getClass())) {</a>
<span class="sourceLineNo">064</span><a id="line.64"> String msg = "Invalid object found in SubjectContext Map under key [" + key + "]. Expected type " +</a>
<span class="sourceLineNo">065</span><a id="line.65"> "was [" + type.getName() + "], but the object under that key is of type " +</a>
<span class="sourceLineNo">066</span><a id="line.66"> "[" + o.getClass().getName() + "].";</a>
<span class="sourceLineNo">067</span><a id="line.67"> throw new IllegalArgumentException(msg);</a>
<span class="sourceLineNo">068</span><a id="line.68"> }</a>
<span class="sourceLineNo">069</span><a id="line.69"> found = (E) o;</a>
<span class="sourceLineNo">070</span><a id="line.70"> }</a>
<span class="sourceLineNo">071</span><a id="line.71"> return found;</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"> /**</a>
<span class="sourceLineNo">075</span><a id="line.75"> * Places a value in this context map under the given key only if the given {@code value} argument is not null.</a>
<span class="sourceLineNo">076</span><a id="line.76"> *</a>
<span class="sourceLineNo">077</span><a id="line.77"> * @param key the attribute key under which the non-null value will be stored</a>
<span class="sourceLineNo">078</span><a id="line.78"> * @param value the non-null value to store. If {@code null}, this method does nothing and returns immediately.</a>
<span class="sourceLineNo">079</span><a id="line.79"> */</a>
<span class="sourceLineNo">080</span><a id="line.80"> protected void nullSafePut(String key, Object value) {</a>
<span class="sourceLineNo">081</span><a id="line.81"> if (value != null) {</a>
<span class="sourceLineNo">082</span><a id="line.82"> put(key, value);</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</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 int size() {</a>
<span class="sourceLineNo">087</span><a id="line.87"> return backingMap.size();</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 isEmpty() {</a>
<span class="sourceLineNo">091</span><a id="line.91"> return backingMap.isEmpty();</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 containsKey(Object o) {</a>
<span class="sourceLineNo">095</span><a id="line.95"> return backingMap.containsKey(o);</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 boolean containsValue(Object o) {</a>
<span class="sourceLineNo">099</span><a id="line.99"> return backingMap.containsValue(o);</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 Object get(Object o) {</a>
<span class="sourceLineNo">103</span><a id="line.103"> return backingMap.get(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 Object put(String s, Object o) {</a>
<span class="sourceLineNo">107</span><a id="line.107"> return backingMap.put(s, o);</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 Object remove(Object o) {</a>
<span class="sourceLineNo">111</span><a id="line.111"> return backingMap.remove(o);</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 void putAll(Map&lt;? extends String, ?&gt; map) {</a>
<span class="sourceLineNo">115</span><a id="line.115"> backingMap.putAll(map);</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 void clear() {</a>
<span class="sourceLineNo">119</span><a id="line.119"> backingMap.clear();</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 Set&lt;String&gt; keySet() {</a>
<span class="sourceLineNo">123</span><a id="line.123"> return Collections.unmodifiableSet(backingMap.keySet());</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 Collection&lt;Object&gt; values() {</a>
<span class="sourceLineNo">127</span><a id="line.127"> return Collections.unmodifiableCollection(backingMap.values());</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 Set&lt;Entry&lt;String, Object&gt;&gt; entrySet() {</a>
<span class="sourceLineNo">131</span><a id="line.131"> return Collections.unmodifiableSet(backingMap.entrySet());</a>
<span class="sourceLineNo">132</span><a id="line.132"> }</a>
<span class="sourceLineNo">133</span><a id="line.133">}</a>
</pre>
</div>
</main>
</body>
</html>