Google Git
Sign in
apache / juneau-website / 3ed0d66d8a45920e11f3674fa91e76686a1b7a22 / . / content / site / apidocs-8.2.0 / src-html / org / apache / juneau / xml / Namespace.html
blob: b63e8aef9319da96d689bcd7eecbb0895d4d9287 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.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 or more contributor license agreements. See the NOTICE file *<a name="line.2"></a>
<span class="sourceLineNo">003</span>// * distributed with this work for additional information regarding copyright ownership. The ASF licenses this file *<a name="line.3"></a>
<span class="sourceLineNo">004</span>// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance *<a name="line.4"></a>
<span class="sourceLineNo">005</span>// * with the License. You may obtain a copy of the License at *<a name="line.5"></a>
<span class="sourceLineNo">006</span>// * *<a name="line.6"></a>
<span class="sourceLineNo">007</span>// * http://www.apache.org/licenses/LICENSE-2.0 *<a name="line.7"></a>
<span class="sourceLineNo">008</span>// * *<a name="line.8"></a>
<span class="sourceLineNo">009</span>// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an *<a name="line.9"></a>
<span class="sourceLineNo">010</span>// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the *<a name="line.10"></a>
<span class="sourceLineNo">011</span>// * specific language governing permissions and limitations under the License. *<a name="line.11"></a>
<span class="sourceLineNo">012</span>// ***************************************************************************************************************************<a name="line.12"></a>
<span class="sourceLineNo">013</span>package org.apache.juneau.xml;<a name="line.13"></a>
<span class="sourceLineNo">014</span><a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.util.*;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.util.concurrent.*;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.apache.juneau.*;<a name="line.18"></a>
<span class="sourceLineNo">019</span>import org.apache.juneau.annotation.*;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.juneau.internal.*;<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span>/**<a name="line.22"></a>
<span class="sourceLineNo">023</span> * Represents a simple namespace mapping between a simple name and URI.<a name="line.23"></a>
<span class="sourceLineNo">024</span> *<a name="line.24"></a>
<span class="sourceLineNo">025</span> * &lt;p&gt;<a name="line.25"></a>
<span class="sourceLineNo">026</span> * In general, the simple name will be used as the XML prefix mapping unless there are conflicts or prefix re-mappings<a name="line.26"></a>
<span class="sourceLineNo">027</span> * in the serializer.<a name="line.27"></a>
<span class="sourceLineNo">028</span> */<a name="line.28"></a>
<span class="sourceLineNo">029</span>@Bean(sort=true)<a name="line.29"></a>
<span class="sourceLineNo">030</span>public final class Namespace {<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span> private static final ConcurrentHashMap&lt;String,Namespace&gt; CACHE = new ConcurrentHashMap&lt;&gt;();<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span> /**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * Create a {@link Namespace} with the specified name and URI.<a name="line.36"></a>
<span class="sourceLineNo">037</span> *<a name="line.37"></a>
<span class="sourceLineNo">038</span> * &lt;p&gt;<a name="line.38"></a>
<span class="sourceLineNo">039</span> * Previously-encountered name/uri pairs return a cached copy.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @param name The namespace name. See {@link Namespace#getName()}.<a name="line.41"></a>
<span class="sourceLineNo">042</span> * @param uri The namespace URI. See {@link Namespace#getUri()}.<a name="line.42"></a>
<span class="sourceLineNo">043</span> * @return The namespace object.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> public static Namespace create(String name, String uri) {<a name="line.45"></a>
<span class="sourceLineNo">046</span> String key = name + ":" + uri;<a name="line.46"></a>
<span class="sourceLineNo">047</span> Namespace n = CACHE.get(key);<a name="line.47"></a>
<span class="sourceLineNo">048</span> if (n == null) {<a name="line.48"></a>
<span class="sourceLineNo">049</span> n = new Namespace(key, name, uri);<a name="line.49"></a>
<span class="sourceLineNo">050</span> Namespace n2 = CACHE.putIfAbsent(key, n);<a name="line.50"></a>
<span class="sourceLineNo">051</span> return (n2 == null ? n : n2);<a name="line.51"></a>
<span class="sourceLineNo">052</span> }<a name="line.52"></a>
<span class="sourceLineNo">053</span> return n;<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Create a {@link Namespace} from a &lt;js&gt;"name:uri"&lt;/js&gt; string pair.<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param key The key/pair string.<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @return The namespace object.<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> public static Namespace create(String key) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> Namespace n = CACHE.get(key);<a name="line.63"></a>
<span class="sourceLineNo">064</span> if (n != null)<a name="line.64"></a>
<span class="sourceLineNo">065</span> return n;<a name="line.65"></a>
<span class="sourceLineNo">066</span> int i = key.indexOf(':');<a name="line.66"></a>
<span class="sourceLineNo">067</span> if (i == -1)<a name="line.67"></a>
<span class="sourceLineNo">068</span> return create(key, null);<a name="line.68"></a>
<span class="sourceLineNo">069</span> if (key.startsWith("http://") || key.startsWith("https://"))<a name="line.69"></a>
<span class="sourceLineNo">070</span> return create(null, key);<a name="line.70"></a>
<span class="sourceLineNo">071</span> return create(key.substring(0, i).trim(), key.substring(i+1).trim());<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> * Converts the specified object into a {@link Namespace} object.<a name="line.75"></a>
<span class="sourceLineNo">076</span> *<a name="line.76"></a>
<span class="sourceLineNo">077</span> * &lt;p&gt;<a name="line.77"></a>
<span class="sourceLineNo">078</span> * Can be any of following types:<a name="line.78"></a>
<span class="sourceLineNo">079</span> * &lt;ul&gt;<a name="line.79"></a>
<span class="sourceLineNo">080</span> * &lt;li&gt;A {@link Namespace} object<a name="line.80"></a>
<span class="sourceLineNo">081</span> * &lt;li&gt;A string containing a name/value pair of the form &lt;js&gt;"name:uri"&lt;/js&gt;.<a name="line.81"></a>
<span class="sourceLineNo">082</span> * &lt;/ul&gt;<a name="line.82"></a>
<span class="sourceLineNo">083</span> *<a name="line.83"></a>
<span class="sourceLineNo">084</span> * @param o The input.<a name="line.84"></a>
<span class="sourceLineNo">085</span> * @return The namespace object, or &lt;jk&gt;null&lt;/jk&gt; if the input was &lt;jk&gt;null&lt;/jk&gt; or an empty JSON object.<a name="line.85"></a>
<span class="sourceLineNo">086</span> */<a name="line.86"></a>
<span class="sourceLineNo">087</span> public static Namespace create(Object o) {<a name="line.87"></a>
<span class="sourceLineNo">088</span> if (o == null)<a name="line.88"></a>
<span class="sourceLineNo">089</span> return null;<a name="line.89"></a>
<span class="sourceLineNo">090</span> if (o instanceof Namespace)<a name="line.90"></a>
<span class="sourceLineNo">091</span> return (Namespace)o;<a name="line.91"></a>
<span class="sourceLineNo">092</span> if (o instanceof CharSequence)<a name="line.92"></a>
<span class="sourceLineNo">093</span> return create(o.toString());<a name="line.93"></a>
<span class="sourceLineNo">094</span> throw new BasicRuntimeException("Invalid object type passed to Namespace.create(Object): ''{0}''", o.getClass());<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<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> * Converts the specified object into an array of {@link Namespace} object.<a name="line.98"></a>
<span class="sourceLineNo">099</span> *<a name="line.99"></a>
<span class="sourceLineNo">100</span> * &lt;p&gt;<a name="line.100"></a>
<span class="sourceLineNo">101</span> * Can be any of following types:<a name="line.101"></a>
<span class="sourceLineNo">102</span> * &lt;ul&gt;<a name="line.102"></a>
<span class="sourceLineNo">103</span> * &lt;li&gt;A {@link Namespace} array<a name="line.103"></a>
<span class="sourceLineNo">104</span> * &lt;li&gt;A comma-delimited string with key/value pairs of the form &lt;js&gt;"name:uri"&lt;/js&gt;.<a name="line.104"></a>
<span class="sourceLineNo">105</span> * &lt;li&gt;A &lt;c&gt;Collection&lt;/c&gt; containing any of object that can be passed to {@link #createArray(Object)}.<a name="line.105"></a>
<span class="sourceLineNo">106</span> * &lt;/ul&gt;<a name="line.106"></a>
<span class="sourceLineNo">107</span> *<a name="line.107"></a>
<span class="sourceLineNo">108</span> * @param o The input.<a name="line.108"></a>
<span class="sourceLineNo">109</span> * @return The namespace objects, or &lt;jk&gt;null&lt;/jk&gt; if the input was &lt;jk&gt;null&lt;/jk&gt; or an empty JSON object.<a name="line.109"></a>
<span class="sourceLineNo">110</span> */<a name="line.110"></a>
<span class="sourceLineNo">111</span> @SuppressWarnings("rawtypes")<a name="line.111"></a>
<span class="sourceLineNo">112</span> public static Namespace[] createArray(Object o) {<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> if (o instanceof Namespace[])<a name="line.114"></a>
<span class="sourceLineNo">115</span> return (Namespace[])o;<a name="line.115"></a>
<span class="sourceLineNo">116</span><a name="line.116"></a>
<span class="sourceLineNo">117</span> if (o instanceof String[]) {<a name="line.117"></a>
<span class="sourceLineNo">118</span> String[] ss = (String[])o;<a name="line.118"></a>
<span class="sourceLineNo">119</span> Namespace[] n = new Namespace[ss.length];<a name="line.119"></a>
<span class="sourceLineNo">120</span> for (int i = 0; i &lt; ss.length; i++)<a name="line.120"></a>
<span class="sourceLineNo">121</span> n[i] = create(ss[i]);<a name="line.121"></a>
<span class="sourceLineNo">122</span> return n;<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span><a name="line.124"></a>
<span class="sourceLineNo">125</span> if (o instanceof CharSequence) {<a name="line.125"></a>
<span class="sourceLineNo">126</span> String[] ss = StringUtils.split(o.toString());<a name="line.126"></a>
<span class="sourceLineNo">127</span> Namespace[] n = new Namespace[ss.length];<a name="line.127"></a>
<span class="sourceLineNo">128</span> for (int i = 0; i &lt; ss.length; i++)<a name="line.128"></a>
<span class="sourceLineNo">129</span> n[i] = create(ss[i]);<a name="line.129"></a>
<span class="sourceLineNo">130</span> return n;<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> if (o instanceof Collection) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> Collection c = (Collection)o;<a name="line.134"></a>
<span class="sourceLineNo">135</span> Namespace[] n = new Namespace[c.size()];<a name="line.135"></a>
<span class="sourceLineNo">136</span> int i = 0;<a name="line.136"></a>
<span class="sourceLineNo">137</span> for (Object o2 : c){<a name="line.137"></a>
<span class="sourceLineNo">138</span> if (o2 instanceof Namespace)<a name="line.138"></a>
<span class="sourceLineNo">139</span> n[i] = (Namespace)o2;<a name="line.139"></a>
<span class="sourceLineNo">140</span> else if (o2 instanceof CharSequence)<a name="line.140"></a>
<span class="sourceLineNo">141</span> n[i] = create(o2.toString());<a name="line.141"></a>
<span class="sourceLineNo">142</span> else<a name="line.142"></a>
<span class="sourceLineNo">143</span> throw new BasicRuntimeException("Invalid type passed to NamespaceFactory.createArray: ''{0}''", o);<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span> return n;<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> throw new BasicRuntimeException("Invalid type passed to NamespaceFactory.createArray: ''{0}''", o);<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span><a name="line.151"></a>
<span class="sourceLineNo">152</span> final String key, name, uri;<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
<span class="sourceLineNo">155</span> * Constructor.<a name="line.155"></a>
<span class="sourceLineNo">156</span> *<a name="line.156"></a>
<span class="sourceLineNo">157</span> * @param name The short name of this schema.<a name="line.157"></a>
<span class="sourceLineNo">158</span> * @param uri The URI of this schema.<a name="line.158"></a>
<span class="sourceLineNo">159</span> */<a name="line.159"></a>
<span class="sourceLineNo">160</span> private Namespace(String key, String name, String uri) {<a name="line.160"></a>
<span class="sourceLineNo">161</span> this.key = key;<a name="line.161"></a>
<span class="sourceLineNo">162</span> this.name = name;<a name="line.162"></a>
<span class="sourceLineNo">163</span> this.uri = uri;<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> /**<a name="line.166"></a>
<span class="sourceLineNo">167</span> * Returns the namespace name.<a name="line.167"></a>
<span class="sourceLineNo">168</span> *<a name="line.168"></a>
<span class="sourceLineNo">169</span> * @return The namespace name.<a name="line.169"></a>
<span class="sourceLineNo">170</span> */<a name="line.170"></a>
<span class="sourceLineNo">171</span> public String getName() {<a name="line.171"></a>
<span class="sourceLineNo">172</span> return name;<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span><a name="line.174"></a>
<span class="sourceLineNo">175</span> /**<a name="line.175"></a>
<span class="sourceLineNo">176</span> * Returns the namespace URI.<a name="line.176"></a>
<span class="sourceLineNo">177</span> *<a name="line.177"></a>
<span class="sourceLineNo">178</span> * @return The namespace URI.<a name="line.178"></a>
<span class="sourceLineNo">179</span> */<a name="line.179"></a>
<span class="sourceLineNo">180</span> public String getUri() {<a name="line.180"></a>
<span class="sourceLineNo">181</span> return uri;<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> @Override /* Object */<a name="line.184"></a>
<span class="sourceLineNo">185</span> public String toString() {<a name="line.185"></a>
<span class="sourceLineNo">186</span> return key;<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span>}<a name="line.188"></a>
</pre>
</div>
</body>
</html>