http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/internal/FileUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/internal/FileUtils.html b/content/site/apidocs/src-html/org/apache/juneau/internal/FileUtils.html index cbad6b4..92071fe 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/internal/FileUtils.html +++ b/content/site/apidocs/src-html/org/apache/juneau/internal/FileUtils.html @@ -23,237 +23,159 @@ <span class="sourceLineNo">015</span>import static org.apache.juneau.internal.ThrowableUtils.*;<a name="line.15"></a> <span class="sourceLineNo">016</span><a name="line.16"></a> <span class="sourceLineNo">017</span>import java.io.*;<a name="line.17"></a> -<span class="sourceLineNo">018</span>import java.util.*;<a name="line.18"></a> -<span class="sourceLineNo">019</span>import java.util.ResourceBundle.*;<a name="line.19"></a> -<span class="sourceLineNo">020</span><a name="line.20"></a> -<span class="sourceLineNo">021</span>/**<a name="line.21"></a> -<span class="sourceLineNo">022</span> * File utilities.<a name="line.22"></a> -<span class="sourceLineNo">023</span> */<a name="line.23"></a> -<span class="sourceLineNo">024</span>public class FileUtils {<a name="line.24"></a> -<span class="sourceLineNo">025</span><a name="line.25"></a> -<span class="sourceLineNo">026</span> private static final ResourceBundle.Control RB_CONTROL = ResourceBundle.Control.getControl(Control.FORMAT_DEFAULT);<a name="line.26"></a> -<span class="sourceLineNo">027</span> private static final List<Locale> ROOT_LOCALE = Arrays.asList(Locale.ROOT);<a name="line.27"></a> -<span class="sourceLineNo">028</span><a name="line.28"></a> -<span class="sourceLineNo">029</span> /**<a name="line.29"></a> -<span class="sourceLineNo">030</span> * Same as {@link File#mkdirs()} except throws a RuntimeExeption if directory could not be created.<a name="line.30"></a> -<span class="sourceLineNo">031</span> *<a name="line.31"></a> -<span class="sourceLineNo">032</span> * @param f The directory to create. Must not be <jk>null</jk>.<a name="line.32"></a> -<span class="sourceLineNo">033</span> * @param clean If <jk>true</jk>, deletes the contents of the directory if it already exists.<a name="line.33"></a> -<span class="sourceLineNo">034</span> * @return The same file.<a name="line.34"></a> -<span class="sourceLineNo">035</span> * @throws RuntimeException if directory could not be created.<a name="line.35"></a> -<span class="sourceLineNo">036</span> */<a name="line.36"></a> -<span class="sourceLineNo">037</span> public static File mkdirs(File f, boolean clean) {<a name="line.37"></a> -<span class="sourceLineNo">038</span> assertFieldNotNull(f, "f");<a name="line.38"></a> -<span class="sourceLineNo">039</span> if (f.exists()) {<a name="line.39"></a> -<span class="sourceLineNo">040</span> if (clean) {<a name="line.40"></a> -<span class="sourceLineNo">041</span> if (! delete(f))<a name="line.41"></a> -<span class="sourceLineNo">042</span> throw new RuntimeException("Could not clean directory '"+f.getAbsolutePath()+"'");<a name="line.42"></a> -<span class="sourceLineNo">043</span> } else {<a name="line.43"></a> -<span class="sourceLineNo">044</span> return f;<a name="line.44"></a> -<span class="sourceLineNo">045</span> }<a name="line.45"></a> -<span class="sourceLineNo">046</span> }<a name="line.46"></a> -<span class="sourceLineNo">047</span> if (! f.mkdirs())<a name="line.47"></a> -<span class="sourceLineNo">048</span> throw new RuntimeException("Could not create directory '" + f.getAbsolutePath() + "'");<a name="line.48"></a> -<span class="sourceLineNo">049</span> return f;<a name="line.49"></a> -<span class="sourceLineNo">050</span> }<a name="line.50"></a> -<span class="sourceLineNo">051</span><a name="line.51"></a> -<span class="sourceLineNo">052</span> /**<a name="line.52"></a> -<span class="sourceLineNo">053</span> * Same as {@link #mkdirs(String, boolean)} but uses String path.<a name="line.53"></a> -<span class="sourceLineNo">054</span> *<a name="line.54"></a> -<span class="sourceLineNo">055</span> * @param path The path of the directory to create. Must not be <jk>null</jk><a name="line.55"></a> -<span class="sourceLineNo">056</span> * @param clean If <jk>true</jk>, deletes the contents of the directory if it already exists.<a name="line.56"></a> -<span class="sourceLineNo">057</span> * @return The directory.<a name="line.57"></a> -<span class="sourceLineNo">058</span> */<a name="line.58"></a> -<span class="sourceLineNo">059</span> public static File mkdirs(String path, boolean clean) {<a name="line.59"></a> -<span class="sourceLineNo">060</span> assertFieldNotNull(path, "path");<a name="line.60"></a> -<span class="sourceLineNo">061</span> return mkdirs(new File(path), clean);<a name="line.61"></a> -<span class="sourceLineNo">062</span> }<a name="line.62"></a> -<span class="sourceLineNo">063</span><a name="line.63"></a> -<span class="sourceLineNo">064</span> /**<a name="line.64"></a> -<span class="sourceLineNo">065</span> * Recursively deletes a file or directory.<a name="line.65"></a> -<span class="sourceLineNo">066</span> *<a name="line.66"></a> -<span class="sourceLineNo">067</span> * @param f The file or directory to delete.<a name="line.67"></a> -<span class="sourceLineNo">068</span> * @return <jk>true</jk> if file or directory was successfully deleted.<a name="line.68"></a> -<span class="sourceLineNo">069</span> */<a name="line.69"></a> -<span class="sourceLineNo">070</span> public static boolean delete(File f) {<a name="line.70"></a> -<span class="sourceLineNo">071</span> if (f == null)<a name="line.71"></a> -<span class="sourceLineNo">072</span> return true;<a name="line.72"></a> -<span class="sourceLineNo">073</span> if (f.isDirectory()) {<a name="line.73"></a> -<span class="sourceLineNo">074</span> File[] cf = f.listFiles();<a name="line.74"></a> -<span class="sourceLineNo">075</span> if (cf != null)<a name="line.75"></a> -<span class="sourceLineNo">076</span> for (File c : cf)<a name="line.76"></a> -<span class="sourceLineNo">077</span> delete(c);<a name="line.77"></a> -<span class="sourceLineNo">078</span> }<a name="line.78"></a> -<span class="sourceLineNo">079</span> return f.delete();<a name="line.79"></a> -<span class="sourceLineNo">080</span> }<a name="line.80"></a> -<span class="sourceLineNo">081</span><a name="line.81"></a> -<span class="sourceLineNo">082</span> /**<a name="line.82"></a> -<span class="sourceLineNo">083</span> * Creates a file if it doesn't already exist using {@link File#createNewFile()}.<a name="line.83"></a> -<span class="sourceLineNo">084</span> *<a name="line.84"></a> -<span class="sourceLineNo">085</span> * <p><a name="line.85"></a> -<span class="sourceLineNo">086</span> * Throws a {@link RuntimeException} if the file could not be created.<a name="line.86"></a> -<span class="sourceLineNo">087</span> *<a name="line.87"></a> -<span class="sourceLineNo">088</span> * @param f The file to create.<a name="line.88"></a> -<span class="sourceLineNo">089</span> */<a name="line.89"></a> -<span class="sourceLineNo">090</span> public static void create(File f) {<a name="line.90"></a> -<span class="sourceLineNo">091</span> if (f.exists())<a name="line.91"></a> -<span class="sourceLineNo">092</span> return;<a name="line.92"></a> -<span class="sourceLineNo">093</span> try {<a name="line.93"></a> -<span class="sourceLineNo">094</span> if (! f.createNewFile())<a name="line.94"></a> -<span class="sourceLineNo">095</span> throw new RuntimeException("Could not create file '"+f.getAbsolutePath()+"'");<a name="line.95"></a> -<span class="sourceLineNo">096</span> } catch (IOException e) {<a name="line.96"></a> -<span class="sourceLineNo">097</span> throw new RuntimeException(e);<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><a name="line.100"></a> -<span class="sourceLineNo">101</span> /**<a name="line.101"></a> -<span class="sourceLineNo">102</span> * Updates the modified timestamp on the specified file.<a name="line.102"></a> -<span class="sourceLineNo">103</span> *<a name="line.103"></a> -<span class="sourceLineNo">104</span> * <p><a name="line.104"></a> -<span class="sourceLineNo">105</span> * Method ensures that the timestamp changes even if it's been modified within the past millisecond.<a name="line.105"></a> -<span class="sourceLineNo">106</span> *<a name="line.106"></a> -<span class="sourceLineNo">107</span> * @param f The file to modify the modified timestamp on.<a name="line.107"></a> -<span class="sourceLineNo">108</span> */<a name="line.108"></a> -<span class="sourceLineNo">109</span> public static void modifyTimestamp(File f) {<a name="line.109"></a> -<span class="sourceLineNo">110</span> long lm = f.lastModified();<a name="line.110"></a> -<span class="sourceLineNo">111</span> long l = System.currentTimeMillis();<a name="line.111"></a> -<span class="sourceLineNo">112</span> if (lm == l)<a name="line.112"></a> -<span class="sourceLineNo">113</span> l++;<a name="line.113"></a> -<span class="sourceLineNo">114</span> if (! f.setLastModified(l))<a name="line.114"></a> -<span class="sourceLineNo">115</span> throw new RuntimeException("Could not modify timestamp on file '"+f.getAbsolutePath()+"'");<a name="line.115"></a> -<span class="sourceLineNo">116</span><a name="line.116"></a> -<span class="sourceLineNo">117</span> // Linux only gives 1s precision, so set the date 1s into the future.<a name="line.117"></a> -<span class="sourceLineNo">118</span> if (lm == f.lastModified()) {<a name="line.118"></a> -<span class="sourceLineNo">119</span> l += 1000;<a name="line.119"></a> -<span class="sourceLineNo">120</span> if (! f.setLastModified(l))<a name="line.120"></a> -<span class="sourceLineNo">121</span> throw new RuntimeException("Could not modify timestamp on file '"+f.getAbsolutePath()+"'");<a name="line.121"></a> -<span class="sourceLineNo">122</span> }<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> /**<a name="line.125"></a> -<span class="sourceLineNo">126</span> * Create a temporary file with the specified name.<a name="line.126"></a> -<span class="sourceLineNo">127</span> *<a name="line.127"></a> -<span class="sourceLineNo">128</span> * <p><a name="line.128"></a> -<span class="sourceLineNo">129</span> * The name is broken into file name and suffix, and the parts are passed to<a name="line.129"></a> -<span class="sourceLineNo">130</span> * {@link File#createTempFile(String, String)}.<a name="line.130"></a> -<span class="sourceLineNo">131</span> *<a name="line.131"></a> -<span class="sourceLineNo">132</span> * <p><a name="line.132"></a> -<span class="sourceLineNo">133</span> * {@link File#deleteOnExit()} is called on the resulting file before being returned by this method.<a name="line.133"></a> -<span class="sourceLineNo">134</span> *<a name="line.134"></a> -<span class="sourceLineNo">135</span> * @param name The file name<a name="line.135"></a> -<span class="sourceLineNo">136</span> * @return A newly-created temporary file.<a name="line.136"></a> -<span class="sourceLineNo">137</span> * @throws IOException<a name="line.137"></a> -<span class="sourceLineNo">138</span> */<a name="line.138"></a> -<span class="sourceLineNo">139</span> public static File createTempFile(String name) throws IOException {<a name="line.139"></a> -<span class="sourceLineNo">140</span> String[] parts = name.split("\\.");<a name="line.140"></a> -<span class="sourceLineNo">141</span> File f = File.createTempFile(parts[0], "." + parts[1]);<a name="line.141"></a> -<span class="sourceLineNo">142</span> f.deleteOnExit();<a name="line.142"></a> -<span class="sourceLineNo">143</span> return f;<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> * Strips the extension from a file name.<a name="line.147"></a> -<span class="sourceLineNo">148</span> *<a name="line.148"></a> -<span class="sourceLineNo">149</span> * @param name The file name.<a name="line.149"></a> -<span class="sourceLineNo">150</span> * @return The file name without the extension, or <jk>null</jk> if name was <jk>null</jk>.<a name="line.150"></a> -<span class="sourceLineNo">151</span> */<a name="line.151"></a> -<span class="sourceLineNo">152</span> public static String getBaseName(String name) {<a name="line.152"></a> -<span class="sourceLineNo">153</span> if (name == null)<a name="line.153"></a> -<span class="sourceLineNo">154</span> return null;<a name="line.154"></a> -<span class="sourceLineNo">155</span> int i = name.lastIndexOf('.');<a name="line.155"></a> -<span class="sourceLineNo">156</span> if (i == -1)<a name="line.156"></a> -<span class="sourceLineNo">157</span> return name;<a name="line.157"></a> -<span class="sourceLineNo">158</span> return name.substring(0, i);<a name="line.158"></a> -<span class="sourceLineNo">159</span> }<a name="line.159"></a> -<span class="sourceLineNo">160</span><a name="line.160"></a> -<span class="sourceLineNo">161</span> /**<a name="line.161"></a> -<span class="sourceLineNo">162</span> * Returns the extension from a file name.<a name="line.162"></a> -<span class="sourceLineNo">163</span> *<a name="line.163"></a> -<span class="sourceLineNo">164</span> * @param name The file name.<a name="line.164"></a> -<span class="sourceLineNo">165</span> * @return The the extension, or <jk>null</jk> if name was <jk>null</jk>.<a name="line.165"></a> -<span class="sourceLineNo">166</span> */<a name="line.166"></a> -<span class="sourceLineNo">167</span> public static String getExtension(String name) {<a name="line.167"></a> -<span class="sourceLineNo">168</span> if (name == null)<a name="line.168"></a> -<span class="sourceLineNo">169</span> return null;<a name="line.169"></a> -<span class="sourceLineNo">170</span> int i = name.lastIndexOf('.');<a name="line.170"></a> -<span class="sourceLineNo">171</span> if (i == -1)<a name="line.171"></a> -<span class="sourceLineNo">172</span> return "";<a name="line.172"></a> -<span class="sourceLineNo">173</span> return name.substring(i+1);<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> /**<a name="line.176"></a> -<span class="sourceLineNo">177</span> * Returns the candidate file names for the specified file name in the specified locale.<a name="line.177"></a> -<span class="sourceLineNo">178</span> *<a name="line.178"></a> -<span class="sourceLineNo">179</span> * <p><a name="line.179"></a> -<span class="sourceLineNo">180</span> * For example, if looking for the <js>"MyResource.txt"</js> file in the Japanese locale, the iterator will return<a name="line.180"></a> -<span class="sourceLineNo">181</span> * names in the following order:<a name="line.181"></a> -<span class="sourceLineNo">182</span> * <ol><a name="line.182"></a> -<span class="sourceLineNo">183</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.183"></a> -<span class="sourceLineNo">184</span> * <li><js>"MyResource_ja.txt"</js><a name="line.184"></a> -<span class="sourceLineNo">185</span> * <li><js>"MyResource.txt"</js><a name="line.185"></a> -<span class="sourceLineNo">186</span> * </ol><a name="line.186"></a> -<span class="sourceLineNo">187</span> *<a name="line.187"></a> -<span class="sourceLineNo">188</span> * <p><a name="line.188"></a> -<span class="sourceLineNo">189</span> * If the locale is null, then it will only return <js>"MyResource.txt"</js>.<a name="line.189"></a> -<span class="sourceLineNo">190</span> *<a name="line.190"></a> -<span class="sourceLineNo">191</span> * @param fileName The name of the file to get candidate file names on.<a name="line.191"></a> -<span class="sourceLineNo">192</span> * @param l The locale.<a name="line.192"></a> -<span class="sourceLineNo">193</span> * @return An iterator of file names to look at.<a name="line.193"></a> -<span class="sourceLineNo">194</span> */<a name="line.194"></a> -<span class="sourceLineNo">195</span> public static Iterable<String> getCandidateFileNames(final String fileName, final Locale l) {<a name="line.195"></a> -<span class="sourceLineNo">196</span> return new Iterable<String>() {<a name="line.196"></a> -<span class="sourceLineNo">197</span> @Override<a name="line.197"></a> -<span class="sourceLineNo">198</span> public Iterator<String> iterator() {<a name="line.198"></a> -<span class="sourceLineNo">199</span> return new Iterator<String>() {<a name="line.199"></a> -<span class="sourceLineNo">200</span> final Iterator<Locale> locales = getCandidateLocales(l).iterator();<a name="line.200"></a> -<span class="sourceLineNo">201</span> String baseName, ext;<a name="line.201"></a> -<span class="sourceLineNo">202</span><a name="line.202"></a> -<span class="sourceLineNo">203</span> @Override<a name="line.203"></a> -<span class="sourceLineNo">204</span> public boolean hasNext() {<a name="line.204"></a> -<span class="sourceLineNo">205</span> return locales.hasNext();<a name="line.205"></a> -<span class="sourceLineNo">206</span> }<a name="line.206"></a> -<span class="sourceLineNo">207</span><a name="line.207"></a> -<span class="sourceLineNo">208</span> @Override<a name="line.208"></a> -<span class="sourceLineNo">209</span> public String next() {<a name="line.209"></a> -<span class="sourceLineNo">210</span> Locale l2 = locales.next();<a name="line.210"></a> -<span class="sourceLineNo">211</span> if (l2.toString().isEmpty())<a name="line.211"></a> -<span class="sourceLineNo">212</span> return fileName;<a name="line.212"></a> -<span class="sourceLineNo">213</span> if (baseName == null)<a name="line.213"></a> -<span class="sourceLineNo">214</span> baseName = getBaseName(fileName);<a name="line.214"></a> -<span class="sourceLineNo">215</span> if (ext == null)<a name="line.215"></a> -<span class="sourceLineNo">216</span> ext = getExtension(fileName);<a name="line.216"></a> -<span class="sourceLineNo">217</span> return baseName + "_" + l2.toString() + (ext.isEmpty() ? "" : ('.' + ext));<a name="line.217"></a> -<span class="sourceLineNo">218</span> }<a name="line.218"></a> -<span class="sourceLineNo">219</span> @Override<a name="line.219"></a> -<span class="sourceLineNo">220</span> public void remove() {<a name="line.220"></a> -<span class="sourceLineNo">221</span> throw new UnsupportedOperationException();<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> };<a name="line.225"></a> -<span class="sourceLineNo">226</span> }<a name="line.226"></a> -<span class="sourceLineNo">227</span><a name="line.227"></a> -<span class="sourceLineNo">228</span><a name="line.228"></a> -<span class="sourceLineNo">229</span> /**<a name="line.229"></a> -<span class="sourceLineNo">230</span> * Returns the candidate locales for the specified locale.<a name="line.230"></a> -<span class="sourceLineNo">231</span> *<a name="line.231"></a> -<span class="sourceLineNo">232</span> * <p><a name="line.232"></a> -<span class="sourceLineNo">233</span> * For example, if <code>locale</code> is <js>"ja_JP"</js>, then this method will return:<a name="line.233"></a> -<span class="sourceLineNo">234</span> * <ol><a name="line.234"></a> -<span class="sourceLineNo">235</span> * <li><js>"ja_JP"</js><a name="line.235"></a> -<span class="sourceLineNo">236</span> * <li><js>"ja"</js><a name="line.236"></a> -<span class="sourceLineNo">237</span> * <li><js>""</js><a name="line.237"></a> -<span class="sourceLineNo">238</span> * </ol><a name="line.238"></a> -<span class="sourceLineNo">239</span> *<a name="line.239"></a> -<span class="sourceLineNo">240</span> * @param locale The locale to get the list of candidate locales for.<a name="line.240"></a> -<span class="sourceLineNo">241</span> * @return The list of candidate locales.<a name="line.241"></a> -<span class="sourceLineNo">242</span> */<a name="line.242"></a> -<span class="sourceLineNo">243</span> public static List<Locale> getCandidateLocales(Locale locale) {<a name="line.243"></a> -<span class="sourceLineNo">244</span> if (locale == null)<a name="line.244"></a> -<span class="sourceLineNo">245</span> return ROOT_LOCALE;<a name="line.245"></a> -<span class="sourceLineNo">246</span> return RB_CONTROL.getCandidateLocales("", locale);<a name="line.246"></a> -<span class="sourceLineNo">247</span> }<a name="line.247"></a> -<span class="sourceLineNo">248</span>}<a name="line.248"></a> +<span class="sourceLineNo">018</span><a name="line.18"></a> +<span class="sourceLineNo">019</span>/**<a name="line.19"></a> +<span class="sourceLineNo">020</span> * File utilities.<a name="line.20"></a> +<span class="sourceLineNo">021</span> */<a name="line.21"></a> +<span class="sourceLineNo">022</span>public class FileUtils {<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> * Same as {@link File#mkdirs()} except throws a RuntimeExeption if directory could not be created.<a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * @param f The directory to create. Must not be <jk>null</jk>.<a name="line.27"></a> +<span class="sourceLineNo">028</span> * @param clean If <jk>true</jk>, deletes the contents of the directory if it already exists.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * @return The same file.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * @throws RuntimeException if directory could not be created.<a name="line.30"></a> +<span class="sourceLineNo">031</span> */<a name="line.31"></a> +<span class="sourceLineNo">032</span> public static File mkdirs(File f, boolean clean) {<a name="line.32"></a> +<span class="sourceLineNo">033</span> assertFieldNotNull(f, "f");<a name="line.33"></a> +<span class="sourceLineNo">034</span> if (f.exists()) {<a name="line.34"></a> +<span class="sourceLineNo">035</span> if (clean) {<a name="line.35"></a> +<span class="sourceLineNo">036</span> if (! delete(f))<a name="line.36"></a> +<span class="sourceLineNo">037</span> throw new RuntimeException("Could not clean directory '"+f.getAbsolutePath()+"'");<a name="line.37"></a> +<span class="sourceLineNo">038</span> } else {<a name="line.38"></a> +<span class="sourceLineNo">039</span> return f;<a name="line.39"></a> +<span class="sourceLineNo">040</span> }<a name="line.40"></a> +<span class="sourceLineNo">041</span> }<a name="line.41"></a> +<span class="sourceLineNo">042</span> if (! f.mkdirs())<a name="line.42"></a> +<span class="sourceLineNo">043</span> throw new RuntimeException("Could not create directory '" + f.getAbsolutePath() + "'");<a name="line.43"></a> +<span class="sourceLineNo">044</span> return f;<a name="line.44"></a> +<span class="sourceLineNo">045</span> }<a name="line.45"></a> +<span class="sourceLineNo">046</span><a name="line.46"></a> +<span class="sourceLineNo">047</span> /**<a name="line.47"></a> +<span class="sourceLineNo">048</span> * Same as {@link #mkdirs(String, boolean)} but uses String path.<a name="line.48"></a> +<span class="sourceLineNo">049</span> *<a name="line.49"></a> +<span class="sourceLineNo">050</span> * @param path The path of the directory to create. Must not be <jk>null</jk><a name="line.50"></a> +<span class="sourceLineNo">051</span> * @param clean If <jk>true</jk>, deletes the contents of the directory if it already exists.<a name="line.51"></a> +<span class="sourceLineNo">052</span> * @return The directory.<a name="line.52"></a> +<span class="sourceLineNo">053</span> */<a name="line.53"></a> +<span class="sourceLineNo">054</span> public static File mkdirs(String path, boolean clean) {<a name="line.54"></a> +<span class="sourceLineNo">055</span> assertFieldNotNull(path, "path");<a name="line.55"></a> +<span class="sourceLineNo">056</span> return mkdirs(new File(path), clean);<a name="line.56"></a> +<span class="sourceLineNo">057</span> }<a name="line.57"></a> +<span class="sourceLineNo">058</span><a name="line.58"></a> +<span class="sourceLineNo">059</span> /**<a name="line.59"></a> +<span class="sourceLineNo">060</span> * Recursively deletes a file or directory.<a name="line.60"></a> +<span class="sourceLineNo">061</span> *<a name="line.61"></a> +<span class="sourceLineNo">062</span> * @param f The file or directory to delete.<a name="line.62"></a> +<span class="sourceLineNo">063</span> * @return <jk>true</jk> if file or directory was successfully deleted.<a name="line.63"></a> +<span class="sourceLineNo">064</span> */<a name="line.64"></a> +<span class="sourceLineNo">065</span> public static boolean delete(File f) {<a name="line.65"></a> +<span class="sourceLineNo">066</span> if (f == null)<a name="line.66"></a> +<span class="sourceLineNo">067</span> return true;<a name="line.67"></a> +<span class="sourceLineNo">068</span> if (f.isDirectory()) {<a name="line.68"></a> +<span class="sourceLineNo">069</span> File[] cf = f.listFiles();<a name="line.69"></a> +<span class="sourceLineNo">070</span> if (cf != null)<a name="line.70"></a> +<span class="sourceLineNo">071</span> for (File c : cf)<a name="line.71"></a> +<span class="sourceLineNo">072</span> delete(c);<a name="line.72"></a> +<span class="sourceLineNo">073</span> }<a name="line.73"></a> +<span class="sourceLineNo">074</span> return f.delete();<a name="line.74"></a> +<span class="sourceLineNo">075</span> }<a name="line.75"></a> +<span class="sourceLineNo">076</span><a name="line.76"></a> +<span class="sourceLineNo">077</span> /**<a name="line.77"></a> +<span class="sourceLineNo">078</span> * Creates a file if it doesn't already exist using {@link File#createNewFile()}.<a name="line.78"></a> +<span class="sourceLineNo">079</span> *<a name="line.79"></a> +<span class="sourceLineNo">080</span> * <p><a name="line.80"></a> +<span class="sourceLineNo">081</span> * Throws a {@link RuntimeException} if the file could not be created.<a name="line.81"></a> +<span class="sourceLineNo">082</span> *<a name="line.82"></a> +<span class="sourceLineNo">083</span> * @param f The file to create.<a name="line.83"></a> +<span class="sourceLineNo">084</span> */<a name="line.84"></a> +<span class="sourceLineNo">085</span> public static void create(File f) {<a name="line.85"></a> +<span class="sourceLineNo">086</span> if (f.exists())<a name="line.86"></a> +<span class="sourceLineNo">087</span> return;<a name="line.87"></a> +<span class="sourceLineNo">088</span> try {<a name="line.88"></a> +<span class="sourceLineNo">089</span> if (! f.createNewFile())<a name="line.89"></a> +<span class="sourceLineNo">090</span> throw new RuntimeException("Could not create file '"+f.getAbsolutePath()+"'");<a name="line.90"></a> +<span class="sourceLineNo">091</span> } catch (IOException e) {<a name="line.91"></a> +<span class="sourceLineNo">092</span> throw new RuntimeException(e);<a name="line.92"></a> +<span class="sourceLineNo">093</span> }<a name="line.93"></a> +<span class="sourceLineNo">094</span> }<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> * Updates the modified timestamp on the specified file.<a name="line.97"></a> +<span class="sourceLineNo">098</span> *<a name="line.98"></a> +<span class="sourceLineNo">099</span> * <p><a name="line.99"></a> +<span class="sourceLineNo">100</span> * Method ensures that the timestamp changes even if it's been modified within the past millisecond.<a name="line.100"></a> +<span class="sourceLineNo">101</span> *<a name="line.101"></a> +<span class="sourceLineNo">102</span> * @param f The file to modify the modified timestamp on.<a name="line.102"></a> +<span class="sourceLineNo">103</span> */<a name="line.103"></a> +<span class="sourceLineNo">104</span> public static void modifyTimestamp(File f) {<a name="line.104"></a> +<span class="sourceLineNo">105</span> long lm = f.lastModified();<a name="line.105"></a> +<span class="sourceLineNo">106</span> long l = System.currentTimeMillis();<a name="line.106"></a> +<span class="sourceLineNo">107</span> if (lm == l)<a name="line.107"></a> +<span class="sourceLineNo">108</span> l++;<a name="line.108"></a> +<span class="sourceLineNo">109</span> if (! f.setLastModified(l))<a name="line.109"></a> +<span class="sourceLineNo">110</span> throw new RuntimeException("Could not modify timestamp on file '"+f.getAbsolutePath()+"'");<a name="line.110"></a> +<span class="sourceLineNo">111</span><a name="line.111"></a> +<span class="sourceLineNo">112</span> // Linux only gives 1s precision, so set the date 1s into the future.<a name="line.112"></a> +<span class="sourceLineNo">113</span> if (lm == f.lastModified()) {<a name="line.113"></a> +<span class="sourceLineNo">114</span> l += 1000;<a name="line.114"></a> +<span class="sourceLineNo">115</span> if (! f.setLastModified(l))<a name="line.115"></a> +<span class="sourceLineNo">116</span> throw new RuntimeException("Could not modify timestamp on file '"+f.getAbsolutePath()+"'");<a name="line.116"></a> +<span class="sourceLineNo">117</span> }<a name="line.117"></a> +<span class="sourceLineNo">118</span> }<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> * Create a temporary file with the specified name.<a name="line.121"></a> +<span class="sourceLineNo">122</span> *<a name="line.122"></a> +<span class="sourceLineNo">123</span> * <p><a name="line.123"></a> +<span class="sourceLineNo">124</span> * The name is broken into file name and suffix, and the parts are passed to<a name="line.124"></a> +<span class="sourceLineNo">125</span> * {@link File#createTempFile(String, String)}.<a name="line.125"></a> +<span class="sourceLineNo">126</span> *<a name="line.126"></a> +<span class="sourceLineNo">127</span> * <p><a name="line.127"></a> +<span class="sourceLineNo">128</span> * {@link File#deleteOnExit()} is called on the resulting file before being returned by this method.<a name="line.128"></a> +<span class="sourceLineNo">129</span> *<a name="line.129"></a> +<span class="sourceLineNo">130</span> * @param name The file name<a name="line.130"></a> +<span class="sourceLineNo">131</span> * @return A newly-created temporary file.<a name="line.131"></a> +<span class="sourceLineNo">132</span> * @throws IOException<a name="line.132"></a> +<span class="sourceLineNo">133</span> */<a name="line.133"></a> +<span class="sourceLineNo">134</span> public static File createTempFile(String name) throws IOException {<a name="line.134"></a> +<span class="sourceLineNo">135</span> String[] parts = name.split("\\.");<a name="line.135"></a> +<span class="sourceLineNo">136</span> File f = File.createTempFile(parts[0], "." + parts[1]);<a name="line.136"></a> +<span class="sourceLineNo">137</span> f.deleteOnExit();<a name="line.137"></a> +<span class="sourceLineNo">138</span> return f;<a name="line.138"></a> +<span class="sourceLineNo">139</span> }<a name="line.139"></a> +<span class="sourceLineNo">140</span><a name="line.140"></a> +<span class="sourceLineNo">141</span> /**<a name="line.141"></a> +<span class="sourceLineNo">142</span> * Strips the extension from a file name.<a name="line.142"></a> +<span class="sourceLineNo">143</span> *<a name="line.143"></a> +<span class="sourceLineNo">144</span> * @param name The file name.<a name="line.144"></a> +<span class="sourceLineNo">145</span> * @return The file name without the extension, or <jk>null</jk> if name was <jk>null</jk>.<a name="line.145"></a> +<span class="sourceLineNo">146</span> */<a name="line.146"></a> +<span class="sourceLineNo">147</span> public static String getBaseName(String name) {<a name="line.147"></a> +<span class="sourceLineNo">148</span> if (name == null)<a name="line.148"></a> +<span class="sourceLineNo">149</span> return null;<a name="line.149"></a> +<span class="sourceLineNo">150</span> int i = name.lastIndexOf('.');<a name="line.150"></a> +<span class="sourceLineNo">151</span> if (i == -1)<a name="line.151"></a> +<span class="sourceLineNo">152</span> return name;<a name="line.152"></a> +<span class="sourceLineNo">153</span> return name.substring(0, i);<a name="line.153"></a> +<span class="sourceLineNo">154</span> }<a name="line.154"></a> +<span class="sourceLineNo">155</span><a name="line.155"></a> +<span class="sourceLineNo">156</span> /**<a name="line.156"></a> +<span class="sourceLineNo">157</span> * Returns the extension from a file name.<a name="line.157"></a> +<span class="sourceLineNo">158</span> *<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @param name The file name.<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @return The the extension, or <jk>null</jk> if name was <jk>null</jk>.<a name="line.160"></a> +<span class="sourceLineNo">161</span> */<a name="line.161"></a> +<span class="sourceLineNo">162</span> public static String getExtension(String name) {<a name="line.162"></a> +<span class="sourceLineNo">163</span> if (name == null)<a name="line.163"></a> +<span class="sourceLineNo">164</span> return null;<a name="line.164"></a> +<span class="sourceLineNo">165</span> int i = name.lastIndexOf('.');<a name="line.165"></a> +<span class="sourceLineNo">166</span> if (i == -1)<a name="line.166"></a> +<span class="sourceLineNo">167</span> return "";<a name="line.167"></a> +<span class="sourceLineNo">168</span> return name.substring(i+1);<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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/internal/ObjectUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/internal/ObjectUtils.html b/content/site/apidocs/src-html/org/apache/juneau/internal/ObjectUtils.html index da46acd..ed9918e 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/internal/ObjectUtils.html +++ b/content/site/apidocs/src-html/org/apache/juneau/internal/ObjectUtils.html @@ -23,59 +23,221 @@ <span class="sourceLineNo">015</span>import java.lang.reflect.*;<a name="line.15"></a> <span class="sourceLineNo">016</span>import java.util.*;<a name="line.16"></a> <span class="sourceLineNo">017</span><a name="line.17"></a> -<span class="sourceLineNo">018</span>/**<a name="line.18"></a> -<span class="sourceLineNo">019</span> * Object-related utility methods.<a name="line.19"></a> -<span class="sourceLineNo">020</span> */<a name="line.20"></a> -<span class="sourceLineNo">021</span>public class ObjectUtils {<a name="line.21"></a> -<span class="sourceLineNo">022</span><a name="line.22"></a> -<span class="sourceLineNo">023</span> /**<a name="line.23"></a> -<span class="sourceLineNo">024</span> * Returns <jk>true</jk> if the specified objects are equal.<a name="line.24"></a> -<span class="sourceLineNo">025</span> *<a name="line.25"></a> -<span class="sourceLineNo">026</span> * <p><a name="line.26"></a> -<span class="sourceLineNo">027</span> * Gracefully handles <jk>null</jk>s.<a name="line.27"></a> -<span class="sourceLineNo">028</span> *<a name="line.28"></a> -<span class="sourceLineNo">029</span> * @param o1 Object #1<a name="line.29"></a> -<span class="sourceLineNo">030</span> * @param o2 Object #2<a name="line.30"></a> -<span class="sourceLineNo">031</span> * @return <jk>true</jk> if the objects are equal or both <jk>null</jk>.<a name="line.31"></a> -<span class="sourceLineNo">032</span> */<a name="line.32"></a> -<span class="sourceLineNo">033</span> public static boolean equals(Object o1, Object o2) {<a name="line.33"></a> -<span class="sourceLineNo">034</span> if (o1 == null && o2 == null)<a name="line.34"></a> -<span class="sourceLineNo">035</span> return true;<a name="line.35"></a> -<span class="sourceLineNo">036</span> if (o1 == null || o2 == null)<a name="line.36"></a> -<span class="sourceLineNo">037</span> return false;<a name="line.37"></a> -<span class="sourceLineNo">038</span> return o1.equals(o2);<a name="line.38"></a> -<span class="sourceLineNo">039</span> }<a name="line.39"></a> -<span class="sourceLineNo">040</span><a name="line.40"></a> -<span class="sourceLineNo">041</span> /**<a name="line.41"></a> -<span class="sourceLineNo">042</span> * Returns <jk>true</jk> if the specified object is empty.<a name="line.42"></a> -<span class="sourceLineNo">043</span> *<a name="line.43"></a> -<span class="sourceLineNo">044</span> * <p><a name="line.44"></a> -<span class="sourceLineNo">045</span> * Return <jk>true</jk> if the value is any of the following:<a name="line.45"></a> -<span class="sourceLineNo">046</span> * <ul><a name="line.46"></a> -<span class="sourceLineNo">047</span> * <li><jk>null</jk><a name="line.47"></a> -<span class="sourceLineNo">048</span> * <li>An empty Collection<a name="line.48"></a> -<span class="sourceLineNo">049</span> * <li>An empty Map<a name="line.49"></a> -<span class="sourceLineNo">050</span> * <li>An empty array<a name="line.50"></a> -<span class="sourceLineNo">051</span> * <li>An empty CharSequence<a name="line.51"></a> -<span class="sourceLineNo">052</span> * <li>An empty String when serialized to a string using {@link Object#toString()}.<a name="line.52"></a> -<span class="sourceLineNo">053</span> * </ul><a name="line.53"></a> -<span class="sourceLineNo">054</span> *<a name="line.54"></a> -<span class="sourceLineNo">055</span> * @param o The object to test.<a name="line.55"></a> -<span class="sourceLineNo">056</span> * @return <jk>true</jk> if the specified object is empty.<a name="line.56"></a> -<span class="sourceLineNo">057</span> */<a name="line.57"></a> -<span class="sourceLineNo">058</span> @SuppressWarnings("rawtypes")<a name="line.58"></a> -<span class="sourceLineNo">059</span> public static boolean isEmpty(Object o) {<a name="line.59"></a> -<span class="sourceLineNo">060</span> if (o == null)<a name="line.60"></a> -<span class="sourceLineNo">061</span> return true;<a name="line.61"></a> -<span class="sourceLineNo">062</span> if (o instanceof Collection)<a name="line.62"></a> -<span class="sourceLineNo">063</span> return ((Collection)o).isEmpty();<a name="line.63"></a> -<span class="sourceLineNo">064</span> if (o instanceof Map)<a name="line.64"></a> -<span class="sourceLineNo">065</span> return ((Map)o).isEmpty();<a name="line.65"></a> -<span class="sourceLineNo">066</span> if (o.getClass().isArray())<a name="line.66"></a> -<span class="sourceLineNo">067</span> return (Array.getLength(o) == 0);<a name="line.67"></a> -<span class="sourceLineNo">068</span> return o.toString().isEmpty();<a name="line.68"></a> -<span class="sourceLineNo">069</span> }<a name="line.69"></a> -<span class="sourceLineNo">070</span>}<a name="line.70"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span>import org.apache.juneau.transform.*;<a name="line.19"></a> +<span class="sourceLineNo">020</span><a name="line.20"></a> +<span class="sourceLineNo">021</span>/**<a name="line.21"></a> +<span class="sourceLineNo">022</span> * Utility class for efficiently converting objects between types.<a name="line.22"></a> +<span class="sourceLineNo">023</span> *<a name="line.23"></a> +<span class="sourceLineNo">024</span> * <p><a name="line.24"></a> +<span class="sourceLineNo">025</span> * If the value isn't an instance of the specified type, then converts the value if possible.<a name="line.25"></a> +<span class="sourceLineNo">026</span> *<a name="line.26"></a> +<span class="sourceLineNo">027</span> * <p><a name="line.27"></a> +<span class="sourceLineNo">028</span> * The following conversions are valid:<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <table class='styled'><a name="line.29"></a> +<span class="sourceLineNo">030</span> * <tr><th>Convert to type</th><th>Valid input value types</th><th>Notes</th></tr><a name="line.30"></a> +<span class="sourceLineNo">031</span> * <tr><a name="line.31"></a> +<span class="sourceLineNo">032</span> * <td><a name="line.32"></a> +<span class="sourceLineNo">033</span> * A class that is the normal type of a registered {@link PojoSwap}.<a name="line.33"></a> +<span class="sourceLineNo">034</span> * </td><a name="line.34"></a> +<span class="sourceLineNo">035</span> * <td><a name="line.35"></a> +<span class="sourceLineNo">036</span> * A value whose class matches the transformed type of that registered {@link PojoSwap}.<a name="line.36"></a> +<span class="sourceLineNo">037</span> * </td><a name="line.37"></a> +<span class="sourceLineNo">038</span> * <td>&nbsp;</td><a name="line.38"></a> +<span class="sourceLineNo">039</span> * </tr><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <tr><a name="line.40"></a> +<span class="sourceLineNo">041</span> * <td><a name="line.41"></a> +<span class="sourceLineNo">042</span> * A class that is the transformed type of a registered {@link PojoSwap}.<a name="line.42"></a> +<span class="sourceLineNo">043</span> * </td><a name="line.43"></a> +<span class="sourceLineNo">044</span> * <td><a name="line.44"></a> +<span class="sourceLineNo">045</span> * A value whose class matches the normal type of that registered {@link PojoSwap}.<a name="line.45"></a> +<span class="sourceLineNo">046</span> * </td><a name="line.46"></a> +<span class="sourceLineNo">047</span> * <td>&nbsp;</td><a name="line.47"></a> +<span class="sourceLineNo">048</span> * </tr><a name="line.48"></a> +<span class="sourceLineNo">049</span> * <tr><a name="line.49"></a> +<span class="sourceLineNo">050</span> * <td><a name="line.50"></a> +<span class="sourceLineNo">051</span> * {@code Number} (e.g. {@code Integer}, {@code Short}, {@code Float},...)<a name="line.51"></a> +<span class="sourceLineNo">052</span> * <br><code>Number.<jsf>TYPE</jsf></code> (e.g. <code>Integer.<jsf>TYPE</jsf></code>,<a name="line.52"></a> +<span class="sourceLineNo">053</span> * <code>Short.<jsf>TYPE</jsf></code>, <code>Float.<jsf>TYPE</jsf></code>,...)<a name="line.53"></a> +<span class="sourceLineNo">054</span> * </td><a name="line.54"></a> +<span class="sourceLineNo">055</span> * <td><a name="line.55"></a> +<span class="sourceLineNo">056</span> * {@code Number}, {@code String}, <jk>null</jk><a name="line.56"></a> +<span class="sourceLineNo">057</span> * </td><a name="line.57"></a> +<span class="sourceLineNo">058</span> * <td><a name="line.58"></a> +<span class="sourceLineNo">059</span> * For primitive {@code TYPES}, <jk>null</jk> returns the JVM default value for that type.<a name="line.59"></a> +<span class="sourceLineNo">060</span> * </td><a name="line.60"></a> +<span class="sourceLineNo">061</span> * </tr><a name="line.61"></a> +<span class="sourceLineNo">062</span> * <tr><a name="line.62"></a> +<span class="sourceLineNo">063</span> * <td><a name="line.63"></a> +<span class="sourceLineNo">064</span> * {@code Map} (e.g. {@code Map}, {@code HashMap}, {@code TreeMap}, {@code ObjectMap})<a name="line.64"></a> +<span class="sourceLineNo">065</span> * </td><a name="line.65"></a> +<span class="sourceLineNo">066</span> * <td><a name="line.66"></a> +<span class="sourceLineNo">067</span> * {@code Map}<a name="line.67"></a> +<span class="sourceLineNo">068</span> * </td><a name="line.68"></a> +<span class="sourceLineNo">069</span> * <td><a name="line.69"></a> +<span class="sourceLineNo">070</span> * If {@code Map} is not constructible, a {@code ObjectMap} is created.<a name="line.70"></a> +<span class="sourceLineNo">071</span> * </td><a name="line.71"></a> +<span class="sourceLineNo">072</span> * </tr><a name="line.72"></a> +<span class="sourceLineNo">073</span> * <tr><a name="line.73"></a> +<span class="sourceLineNo">074</span> * <td><a name="line.74"></a> +<span class="sourceLineNo">075</span> * {@code Collection} (e.g. {@code List}, {@code LinkedList}, {@code HashSet}, {@code ObjectList})<a name="line.75"></a> +<span class="sourceLineNo">076</span> * </td><a name="line.76"></a> +<span class="sourceLineNo">077</span> * <td><a name="line.77"></a> +<span class="sourceLineNo">078</span> * {@code Collection<Object>}<a name="line.78"></a> +<span class="sourceLineNo">079</span> * <br>{@code Object[]}<a name="line.79"></a> +<span class="sourceLineNo">080</span> * </td><a name="line.80"></a> +<span class="sourceLineNo">081</span> * <td><a name="line.81"></a> +<span class="sourceLineNo">082</span> * If {@code Collection} is not constructible, a {@code ObjectList} is created.<a name="line.82"></a> +<span class="sourceLineNo">083</span> * </td><a name="line.83"></a> +<span class="sourceLineNo">084</span> * </tr><a name="line.84"></a> +<span class="sourceLineNo">085</span> * <tr><a name="line.85"></a> +<span class="sourceLineNo">086</span> * <td><a name="line.86"></a> +<span class="sourceLineNo">087</span> * {@code X[]} (array of any type X)<a name="line.87"></a> +<span class="sourceLineNo">088</span> * </td><a name="line.88"></a> +<span class="sourceLineNo">089</span> * <td><a name="line.89"></a> +<span class="sourceLineNo">090</span> * {@code List<X>}<a name="line.90"></a> +<span class="sourceLineNo">091</span> * </td><a name="line.91"></a> +<span class="sourceLineNo">092</span> * <td>&nbsp;</td><a name="line.92"></a> +<span class="sourceLineNo">093</span> * </tr><a name="line.93"></a> +<span class="sourceLineNo">094</span> * <tr><a name="line.94"></a> +<span class="sourceLineNo">095</span> * <td><a name="line.95"></a> +<span class="sourceLineNo">096</span> * {@code X[][]} (multi-dimensional arrays)<a name="line.96"></a> +<span class="sourceLineNo">097</span> * </td><a name="line.97"></a> +<span class="sourceLineNo">098</span> * <td><a name="line.98"></a> +<span class="sourceLineNo">099</span> * {@code List<List<X>>}<a name="line.99"></a> +<span class="sourceLineNo">100</span> * <br>{@code List<X[]>}<a name="line.100"></a> +<span class="sourceLineNo">101</span> * <br>{@code List[]<X>}<a name="line.101"></a> +<span class="sourceLineNo">102</span> * </td><a name="line.102"></a> +<span class="sourceLineNo">103</span> * <td>&nbsp;</td><a name="line.103"></a> +<span class="sourceLineNo">104</span> * </tr><a name="line.104"></a> +<span class="sourceLineNo">105</span> * <tr><a name="line.105"></a> +<span class="sourceLineNo">106</span> * <td><a name="line.106"></a> +<span class="sourceLineNo">107</span> * {@code Enum}<a name="line.107"></a> +<span class="sourceLineNo">108</span> * </td><a name="line.108"></a> +<span class="sourceLineNo">109</span> * <td><a name="line.109"></a> +<span class="sourceLineNo">110</span> * {@code String}<a name="line.110"></a> +<span class="sourceLineNo">111</span> * </td><a name="line.111"></a> +<span class="sourceLineNo">112</span> * <td>&nbsp;</td><a name="line.112"></a> +<span class="sourceLineNo">113</span> * </tr><a name="line.113"></a> +<span class="sourceLineNo">114</span> * <tr><a name="line.114"></a> +<span class="sourceLineNo">115</span> * <td><a name="line.115"></a> +<span class="sourceLineNo">116</span> * Bean<a name="line.116"></a> +<span class="sourceLineNo">117</span> * </td><a name="line.117"></a> +<span class="sourceLineNo">118</span> * <td><a name="line.118"></a> +<span class="sourceLineNo">119</span> * {@code Map}<a name="line.119"></a> +<span class="sourceLineNo">120</span> * </td><a name="line.120"></a> +<span class="sourceLineNo">121</span> * <td>&nbsp;</td><a name="line.121"></a> +<span class="sourceLineNo">122</span> * </tr><a name="line.122"></a> +<span class="sourceLineNo">123</span> * <tr><a name="line.123"></a> +<span class="sourceLineNo">124</span> * <td><a name="line.124"></a> +<span class="sourceLineNo">125</span> * {@code String}<a name="line.125"></a> +<span class="sourceLineNo">126</span> * </td><a name="line.126"></a> +<span class="sourceLineNo">127</span> * <td><a name="line.127"></a> +<span class="sourceLineNo">128</span> * Anything<a name="line.128"></a> +<span class="sourceLineNo">129</span> * </td><a name="line.129"></a> +<span class="sourceLineNo">130</span> * <td><a name="line.130"></a> +<span class="sourceLineNo">131</span> * Arrays are converted to JSON arrays<a name="line.131"></a> +<span class="sourceLineNo">132</span> * </td><a name="line.132"></a> +<span class="sourceLineNo">133</span> * </tr><a name="line.133"></a> +<span class="sourceLineNo">134</span> * <tr><a name="line.134"></a> +<span class="sourceLineNo">135</span> * <td><a name="line.135"></a> +<span class="sourceLineNo">136</span> * Anything with one of the following methods:<a name="line.136"></a> +<span class="sourceLineNo">137</span> * <br><code><jk>public static</jk> T fromString(String)</code><a name="line.137"></a> +<span class="sourceLineNo">138</span> * <br><code><jk>public static</jk> T valueOf(String)</code><a name="line.138"></a> +<span class="sourceLineNo">139</span> * <br><code><jk>public</jk> T(String)</code><a name="line.139"></a> +<span class="sourceLineNo">140</span> * </td><a name="line.140"></a> +<span class="sourceLineNo">141</span> * <td><a name="line.141"></a> +<span class="sourceLineNo">142</span> * <code>String</code><a name="line.142"></a> +<span class="sourceLineNo">143</span> * </td><a name="line.143"></a> +<span class="sourceLineNo">144</span> * <td><a name="line.144"></a> +<span class="sourceLineNo">145</span> * <br><a name="line.145"></a> +<span class="sourceLineNo">146</span> * </td><a name="line.146"></a> +<span class="sourceLineNo">147</span> * </tr><a name="line.147"></a> +<span class="sourceLineNo">148</span> * </table><a name="line.148"></a> +<span class="sourceLineNo">149</span> */<a name="line.149"></a> +<span class="sourceLineNo">150</span>public class ObjectUtils {<a name="line.150"></a> +<span class="sourceLineNo">151</span><a name="line.151"></a> +<span class="sourceLineNo">152</span> // Session objects are usually not thread safe, but we're not using any feature<a name="line.152"></a> +<span class="sourceLineNo">153</span> // of bean sessions that would cause thread safety issues.<a name="line.153"></a> +<span class="sourceLineNo">154</span> private static final BeanSession session = BeanContext.DEFAULT.createSession();<a name="line.154"></a> +<span class="sourceLineNo">155</span><a name="line.155"></a> +<span class="sourceLineNo">156</span> /**<a name="line.156"></a> +<span class="sourceLineNo">157</span> * Converts the specified object to the specified type.<a name="line.157"></a> +<span class="sourceLineNo">158</span> *<a name="line.158"></a> +<span class="sourceLineNo">159</span> * @param <T> The class type to convert the value to.<a name="line.159"></a> +<span class="sourceLineNo">160</span> * @param value The value to convert.<a name="line.160"></a> +<span class="sourceLineNo">161</span> * @param type The class type to convert the value to.<a name="line.161"></a> +<span class="sourceLineNo">162</span> * @throws InvalidDataConversionException If the specified value cannot be converted to the specified type.<a name="line.162"></a> +<span class="sourceLineNo">163</span> * @return The converted value.<a name="line.163"></a> +<span class="sourceLineNo">164</span> */<a name="line.164"></a> +<span class="sourceLineNo">165</span> public static <T> T convertToType(Object value, Class<T> type) {<a name="line.165"></a> +<span class="sourceLineNo">166</span> return session.convertToType(value, type);<a name="line.166"></a> +<span class="sourceLineNo">167</span> }<a name="line.167"></a> +<span class="sourceLineNo">168</span><a name="line.168"></a> +<span class="sourceLineNo">169</span> /**<a name="line.169"></a> +<span class="sourceLineNo">170</span> * Converts the specified object to the specified type.<a name="line.170"></a> +<span class="sourceLineNo">171</span> *<a name="line.171"></a> +<span class="sourceLineNo">172</span> * @param <T> The class type to convert the value to.<a name="line.172"></a> +<span class="sourceLineNo">173</span> * @param outer<a name="line.173"></a> +<span class="sourceLineNo">174</span> * If class is a member class, this is the instance of the containing class.<a name="line.174"></a> +<span class="sourceLineNo">175</span> * Should be <jk>null</jk> if not a member class.<a name="line.175"></a> +<span class="sourceLineNo">176</span> * @param value The value to convert.<a name="line.176"></a> +<span class="sourceLineNo">177</span> * @param type The class type to convert the value to.<a name="line.177"></a> +<span class="sourceLineNo">178</span> * @throws InvalidDataConversionException If the specified value cannot be converted to the specified type.<a name="line.178"></a> +<span class="sourceLineNo">179</span> * @return The converted value.<a name="line.179"></a> +<span class="sourceLineNo">180</span> */<a name="line.180"></a> +<span class="sourceLineNo">181</span> public static <T> T convertToType(Object outer, Object value, Class<T> type) {<a name="line.181"></a> +<span class="sourceLineNo">182</span> return session.convertToType(outer, value, type);<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> /**<a name="line.185"></a> +<span class="sourceLineNo">186</span> * Returns <jk>true</jk> if the specified objects are equal.<a name="line.186"></a> +<span class="sourceLineNo">187</span> *<a name="line.187"></a> +<span class="sourceLineNo">188</span> * <p><a name="line.188"></a> +<span class="sourceLineNo">189</span> * Gracefully handles <jk>null</jk>s.<a name="line.189"></a> +<span class="sourceLineNo">190</span> *<a name="line.190"></a> +<span class="sourceLineNo">191</span> * @param o1 Object #1<a name="line.191"></a> +<span class="sourceLineNo">192</span> * @param o2 Object #2<a name="line.192"></a> +<span class="sourceLineNo">193</span> * @return <jk>true</jk> if the objects are equal or both <jk>null</jk>.<a name="line.193"></a> +<span class="sourceLineNo">194</span> */<a name="line.194"></a> +<span class="sourceLineNo">195</span> public static boolean equals(Object o1, Object o2) {<a name="line.195"></a> +<span class="sourceLineNo">196</span> if (o1 == null && o2 == null)<a name="line.196"></a> +<span class="sourceLineNo">197</span> return true;<a name="line.197"></a> +<span class="sourceLineNo">198</span> if (o1 == null || o2 == null)<a name="line.198"></a> +<span class="sourceLineNo">199</span> return false;<a name="line.199"></a> +<span class="sourceLineNo">200</span> return o1.equals(o2);<a name="line.200"></a> +<span class="sourceLineNo">201</span> }<a name="line.201"></a> +<span class="sourceLineNo">202</span><a name="line.202"></a> +<span class="sourceLineNo">203</span> /**<a name="line.203"></a> +<span class="sourceLineNo">204</span> * Returns <jk>true</jk> if the specified object is empty.<a name="line.204"></a> +<span class="sourceLineNo">205</span> *<a name="line.205"></a> +<span class="sourceLineNo">206</span> * <p><a name="line.206"></a> +<span class="sourceLineNo">207</span> * Return <jk>true</jk> if the value is any of the following:<a name="line.207"></a> +<span class="sourceLineNo">208</span> * <ul><a name="line.208"></a> +<span class="sourceLineNo">209</span> * <li><jk>null</jk><a name="line.209"></a> +<span class="sourceLineNo">210</span> * <li>An empty Collection<a name="line.210"></a> +<span class="sourceLineNo">211</span> * <li>An empty Map<a name="line.211"></a> +<span class="sourceLineNo">212</span> * <li>An empty array<a name="line.212"></a> +<span class="sourceLineNo">213</span> * <li>An empty CharSequence<a name="line.213"></a> +<span class="sourceLineNo">214</span> * <li>An empty String when serialized to a string using {@link Object#toString()}.<a name="line.214"></a> +<span class="sourceLineNo">215</span> * </ul><a name="line.215"></a> +<span class="sourceLineNo">216</span> *<a name="line.216"></a> +<span class="sourceLineNo">217</span> * @param o The object to test.<a name="line.217"></a> +<span class="sourceLineNo">218</span> * @return <jk>true</jk> if the specified object is empty.<a name="line.218"></a> +<span class="sourceLineNo">219</span> */<a name="line.219"></a> +<span class="sourceLineNo">220</span> @SuppressWarnings("rawtypes")<a name="line.220"></a> +<span class="sourceLineNo">221</span> public static boolean isEmpty(Object o) {<a name="line.221"></a> +<span class="sourceLineNo">222</span> if (o == null)<a name="line.222"></a> +<span class="sourceLineNo">223</span> return true;<a name="line.223"></a> +<span class="sourceLineNo">224</span> if (o instanceof Collection)<a name="line.224"></a> +<span class="sourceLineNo">225</span> return ((Collection)o).isEmpty();<a name="line.225"></a> +<span class="sourceLineNo">226</span> if (o instanceof Map)<a name="line.226"></a> +<span class="sourceLineNo">227</span> return ((Map)o).isEmpty();<a name="line.227"></a> +<span class="sourceLineNo">228</span> if (o.getClass().isArray())<a name="line.228"></a> +<span class="sourceLineNo">229</span> return (Array.getLength(o) == 0);<a name="line.229"></a> +<span class="sourceLineNo">230</span> return o.toString().isEmpty();<a name="line.230"></a> +<span class="sourceLineNo">231</span> }<a name="line.231"></a> +<span class="sourceLineNo">232</span>}<a name="line.232"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/internal/ReflectionUtils.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/internal/ReflectionUtils.html b/content/site/apidocs/src-html/org/apache/juneau/internal/ReflectionUtils.html index 4b45b09..5e24ad0 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/internal/ReflectionUtils.html +++ b/content/site/apidocs/src-html/org/apache/juneau/internal/ReflectionUtils.html @@ -196,38 +196,8 @@ <span class="sourceLineNo">188</span> }<a name="line.188"></a> <span class="sourceLineNo">189</span> return null;<a name="line.189"></a> <span class="sourceLineNo">190</span> }<a name="line.190"></a> -<span class="sourceLineNo">191</span><a name="line.191"></a> -<span class="sourceLineNo">192</span> /**<a name="line.192"></a> -<span class="sourceLineNo">193</span> * Similar to {@link #getResource(Class, String)} except looks for localized versions of the specified resource.<a name="line.193"></a> -<span class="sourceLineNo">194</span> *<a name="line.194"></a> -<span class="sourceLineNo">195</span> * <p><a name="line.195"></a> -<span class="sourceLineNo">196</span> * For example, if looking in the Japanese locale, the order of lookup on the <js>"MyResource.txt"</js> file is:<a name="line.196"></a> -<span class="sourceLineNo">197</span> * <ol><a name="line.197"></a> -<span class="sourceLineNo">198</span> * <li><js>"MyResource_ja_JP.txt"</js><a name="line.198"></a> -<span class="sourceLineNo">199</span> * <li><js>"MyResource_ja.txt"</js><a name="line.199"></a> -<span class="sourceLineNo">200</span> * <li><js>"MyResource.txt"</js><a name="line.200"></a> -<span class="sourceLineNo">201</span> * </ol><a name="line.201"></a> -<span class="sourceLineNo">202</span> *<a name="line.202"></a> -<span class="sourceLineNo">203</span> * @param c The class to return the resource on.<a name="line.203"></a> -<span class="sourceLineNo">204</span> * @param name The resource name.<a name="line.204"></a> -<span class="sourceLineNo">205</span> * @param locale The locale of the resource.<a name="line.205"></a> -<span class="sourceLineNo">206</span> * @return An input stream on the specified resource, or <jk>null</jk> if the resource could not be found.<a name="line.206"></a> -<span class="sourceLineNo">207</span> */<a name="line.207"></a> -<span class="sourceLineNo">208</span> public static InputStream getLocalizedResource(Class<?> c, String name, Locale locale) {<a name="line.208"></a> -<span class="sourceLineNo">209</span> if (locale == null || locale.toString().isEmpty())<a name="line.209"></a> -<span class="sourceLineNo">210</span> return getResource(c, name);<a name="line.210"></a> -<span class="sourceLineNo">211</span> while (c != null) {<a name="line.211"></a> -<span class="sourceLineNo">212</span> for (String n : FileUtils.getCandidateFileNames(name, locale)) {<a name="line.212"></a> -<span class="sourceLineNo">213</span> InputStream is = c.getResourceAsStream(n);<a name="line.213"></a> -<span class="sourceLineNo">214</span> if (is != null)<a name="line.214"></a> -<span class="sourceLineNo">215</span> return is;<a name="line.215"></a> -<span class="sourceLineNo">216</span> }<a name="line.216"></a> -<span class="sourceLineNo">217</span> c = c.getSuperclass();<a name="line.217"></a> -<span class="sourceLineNo">218</span> }<a name="line.218"></a> -<span class="sourceLineNo">219</span> return null;<a name="line.219"></a> -<span class="sourceLineNo">220</span> }<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">191</span>}<a name="line.191"></a> +<span class="sourceLineNo">192</span><a name="line.192"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/microservice/Resource.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/microservice/Resource.html b/content/site/apidocs/src-html/org/apache/juneau/microservice/Resource.html index a658c94..dfeaade 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/microservice/Resource.html +++ b/content/site/apidocs/src-html/org/apache/juneau/microservice/Resource.html @@ -51,10 +51,10 @@ <span class="sourceLineNo">043</span>@SuppressWarnings("serial")<a name="line.43"></a> <span class="sourceLineNo">044</span>@RestResource(<a name="line.44"></a> <span class="sourceLineNo">045</span> htmldoc=@HtmlDoc(<a name="line.45"></a> -<span class="sourceLineNo">046</span> links="{up:'request:/..',options:'servlet:/?method=OPTIONS'}"<a name="line.46"></a> -<span class="sourceLineNo">047</span> ),<a name="line.47"></a> -<span class="sourceLineNo">048</span> config="$S{juneau.configFile}",<a name="line.48"></a> -<span class="sourceLineNo">049</span> stylesheet="$C{REST/stylesheet,styles/juneau.css}"<a name="line.49"></a> +<span class="sourceLineNo">046</span> links="{up:'request:/..',options:'servlet:/?method=OPTIONS'}",<a name="line.46"></a> +<span class="sourceLineNo">047</span> styleImport="$C{REST/stylesheet,servlet:/styles/devops.css}"<a name="line.47"></a> +<span class="sourceLineNo">048</span> ),<a name="line.48"></a> +<span class="sourceLineNo">049</span> config="$S{juneau.configFile}"<a name="line.49"></a> <span class="sourceLineNo">050</span>)<a name="line.50"></a> <span class="sourceLineNo">051</span>public abstract class Resource extends RestServletDefault {<a name="line.51"></a> <span class="sourceLineNo">052</span><a name="line.52"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceGroup.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceGroup.html b/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceGroup.html index 548c432..3838671 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceGroup.html +++ b/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceGroup.html @@ -52,10 +52,10 @@ <span class="sourceLineNo">044</span>@SuppressWarnings("serial")<a name="line.44"></a> <span class="sourceLineNo">045</span>@RestResource(<a name="line.45"></a> <span class="sourceLineNo">046</span> htmldoc=@HtmlDoc(<a name="line.46"></a> -<span class="sourceLineNo">047</span> links="{up:'request:/..',options:'servlet:/?method=OPTIONS'}"<a name="line.47"></a> -<span class="sourceLineNo">048</span> ),<a name="line.48"></a> -<span class="sourceLineNo">049</span> config="$S{juneau.configFile}",<a name="line.49"></a> -<span class="sourceLineNo">050</span> stylesheet="$C{REST/stylesheet,styles/juneau.css}"<a name="line.50"></a> +<span class="sourceLineNo">047</span> links="{up:'request:/..',options:'servlet:/?method=OPTIONS'}",<a name="line.47"></a> +<span class="sourceLineNo">048</span> styleImport="$C{REST/stylesheet,servlet:/styles/devops.css}"<a name="line.48"></a> +<span class="sourceLineNo">049</span> ),<a name="line.49"></a> +<span class="sourceLineNo">050</span> config="$S{juneau.configFile}"<a name="line.50"></a> <span class="sourceLineNo">051</span>)<a name="line.51"></a> <span class="sourceLineNo">052</span>public abstract class ResourceGroup extends RestServletGroupDefault {<a name="line.52"></a> <span class="sourceLineNo">053</span><a name="line.53"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJena.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJena.html b/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJena.html index cce00dd..7402869 100644 --- a/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJena.html +++ b/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJena.html @@ -29,10 +29,10 @@ <span class="sourceLineNo">021</span>@SuppressWarnings("serial")<a name="line.21"></a> <span class="sourceLineNo">022</span>@RestResource(<a name="line.22"></a> <span class="sourceLineNo">023</span> htmldoc=@HtmlDoc(<a name="line.23"></a> -<span class="sourceLineNo">024</span> links="{up:'request:/..',options:'servlet:/?method=OPTIONS'}"<a name="line.24"></a> -<span class="sourceLineNo">025</span> ),<a name="line.25"></a> -<span class="sourceLineNo">026</span> config="$S{juneau.configFile}",<a name="line.26"></a> -<span class="sourceLineNo">027</span> stylesheet="$C{REST/stylesheet,styles/juneau.css}"<a name="line.27"></a> +<span class="sourceLineNo">024</span> links="{up:'request:/..',options:'servlet:/?method=OPTIONS'}",<a name="line.24"></a> +<span class="sourceLineNo">025</span> styleImport="$C{REST/stylesheet,servlet:/styles/devops.css}"<a name="line.25"></a> +<span class="sourceLineNo">026</span> ),<a name="line.26"></a> +<span class="sourceLineNo">027</span> config="$S{juneau.configFile}"<a name="line.27"></a> <span class="sourceLineNo">028</span>)<a name="line.28"></a> <span class="sourceLineNo">029</span>public abstract class ResourceJena extends RestServletJenaDefault {}<a name="line.29"></a> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/b5c66cf1/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJenaGroup.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJenaGroup.html b/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJenaGroup.html new file mode 100644 index 0000000..6630fc7 --- /dev/null +++ b/content/site/apidocs/src-html/org/apache/juneau/microservice/ResourceJenaGroup.html @@ -0,0 +1,135 @@ +<!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.microservice;<a name="line.13"></a> +<span class="sourceLineNo">014</span><a name="line.14"></a> +<span class="sourceLineNo">015</span>import org.apache.juneau.rest.*;<a name="line.15"></a> +<span class="sourceLineNo">016</span>import org.apache.juneau.rest.annotation.*;<a name="line.16"></a> +<span class="sourceLineNo">017</span>import org.apache.juneau.rest.jena.*;<a name="line.17"></a> +<span class="sourceLineNo">018</span>import org.apache.juneau.svl.vars.*;<a name="line.18"></a> +<span class="sourceLineNo">019</span><a name="line.19"></a> +<span class="sourceLineNo">020</span>/**<a name="line.20"></a> +<span class="sourceLineNo">021</span> * Superclass for all REST resource groups.<a name="line.21"></a> +<span class="sourceLineNo">022</span> * <a name="line.22"></a> +<span class="sourceLineNo">023</span> * <p><a name="line.23"></a> +<span class="sourceLineNo">024</span> * In additional to the functionality of the {@link RestServletGroupDefault} group,<a name="line.24"></a> +<span class="sourceLineNo">025</span> * augments the {@link RestContext#getVarResolver()} method with the following additional variable types:<a name="line.25"></a> +<span class="sourceLineNo">026</span> * <ul class='spaced-list'><a name="line.26"></a> +<span class="sourceLineNo">027</span> * <li><a name="line.27"></a> +<span class="sourceLineNo">028</span> * <jk>$ARG{...}</jk> - Command line arguments.<a name="line.28"></a> +<span class="sourceLineNo">029</span> * <br>Resolves values from {@link Microservice#getArgs()}.<a name="line.29"></a> +<span class="sourceLineNo">030</span> * <a name="line.30"></a> +<span class="sourceLineNo">031</span> * <h6>Example:</h6><a name="line.31"></a> +<span class="sourceLineNo">032</span> * <p class='bcode'><a name="line.32"></a> +<span class="sourceLineNo">033</span> * String firstArg = request.getVarResolver().resolve(<js>"$ARG{0}"</js>); <jc>// First argument.</jc><a name="line.33"></a> +<span class="sourceLineNo">034</span> * String namedArg = request.getVarResolver().resolve(<js>"$ARG{myarg}"</js>); <jc>// Named argument (e.g. "myarg=foo"). </jc><a name="line.34"></a> +<span class="sourceLineNo">035</span> * </p><a name="line.35"></a> +<span class="sourceLineNo">036</span> * <li><a name="line.36"></a> +<span class="sourceLineNo">037</span> * <jk>$MF{...}</jk> - Manifest file entries.<a name="line.37"></a> +<span class="sourceLineNo">038</span> * <a name="line.38"></a> +<span class="sourceLineNo">039</span> * <h6>Example:</h6><a name="line.39"></a> +<span class="sourceLineNo">040</span> * <p class='bcode'><a name="line.40"></a> +<span class="sourceLineNo">041</span> * String mainClass = request.getVarResolver().resolve(<js>"$MF{Main-Class}"</js>); <jc>// Main class. </jc><a name="line.41"></a> +<span class="sourceLineNo">042</span> * </p><a name="line.42"></a> +<span class="sourceLineNo">043</span> * </ul><a name="line.43"></a> +<span class="sourceLineNo">044</span> */<a name="line.44"></a> +<span class="sourceLineNo">045</span>@SuppressWarnings("serial")<a name="line.45"></a> +<span class="sourceLineNo">046</span>@RestResource(<a name="line.46"></a> +<span class="sourceLineNo">047</span> htmldoc=@HtmlDoc(<a name="line.47"></a> +<span class="sourceLineNo">048</span> links="{up:'request:/..',options:'servlet:/?method=OPTIONS'}",<a name="line.48"></a> +<span class="sourceLineNo">049</span> styleImport="$C{REST/stylesheet,servlet:/styles/devops.css}"<a name="line.49"></a> +<span class="sourceLineNo">050</span> ),<a name="line.50"></a> +<span class="sourceLineNo">051</span> config="$S{juneau.configFile}"<a name="line.51"></a> +<span class="sourceLineNo">052</span>)<a name="line.52"></a> +<span class="sourceLineNo">053</span>public abstract class ResourceJenaGroup extends RestServletJenaGroupDefault {<a name="line.53"></a> +<span class="sourceLineNo">054</span><a name="line.54"></a> +<span class="sourceLineNo">055</span> @Override /* RestServlet */<a name="line.55"></a> +<span class="sourceLineNo">056</span> public synchronized void init(RestConfig config) throws Exception {<a name="line.56"></a> +<span class="sourceLineNo">057</span> config<a name="line.57"></a> +<span class="sourceLineNo">058</span> .addVars(ArgsVar.class, ManifestFileVar.class)<a name="line.58"></a> +<span class="sourceLineNo">059</span> .addVarContextObject(ArgsVar.SESSION_args, Microservice.getArgs())<a name="line.59"></a> +<span class="sourceLineNo">060</span> .addVarContextObject(ManifestFileVar.SESSION_manifest, Microservice.getManifest());<a name="line.60"></a> +<span class="sourceLineNo">061</span> super.init(config);<a name="line.61"></a> +<span class="sourceLineNo">062</span> }<a name="line.62"></a> +<span class="sourceLineNo">063</span>}<a name="line.63"></a> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</pre> +</div> +</body> +</html>
