PageRenderTime 69ms CodeModel.GetById 27ms RepoModel.GetById 0ms app.codeStats 1ms

/share/doc/hadoop/api/src-html/org/apache/hadoop/fs/Path.html

https://bitbucket.org/cochung/hadoop-2.6.5
HTML | 546 lines | 546 code | 0 blank | 0 comment | 0 complexity | f72a201a9793267c72a7504b370c85a0 MD5 | raw file
Possible License(s): Apache-2.0
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html lang="en">
  3. <head>
  4. <title>Source code</title>
  5. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
  6. </head>
  7. <body>
  8. <div class="sourceContainer">
  9. <pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a>
  10. <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
  11. <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
  12. <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
  13. <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
  14. <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
  15. <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
  16. <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
  17. <span class="sourceLineNo">009</span> *<a name="line.9"></a>
  18. <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
  19. <span class="sourceLineNo">011</span> *<a name="line.11"></a>
  20. <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
  21. <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
  22. <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
  23. <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a>
  24. <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a>
  25. <span class="sourceLineNo">017</span> */<a name="line.17"></a>
  26. <span class="sourceLineNo">018</span><a name="line.18"></a>
  27. <span class="sourceLineNo">019</span>package org.apache.hadoop.fs;<a name="line.19"></a>
  28. <span class="sourceLineNo">020</span><a name="line.20"></a>
  29. <span class="sourceLineNo">021</span>import java.io.IOException;<a name="line.21"></a>
  30. <span class="sourceLineNo">022</span>import java.net.URI;<a name="line.22"></a>
  31. <span class="sourceLineNo">023</span>import java.net.URISyntaxException;<a name="line.23"></a>
  32. <span class="sourceLineNo">024</span>import java.util.regex.Pattern;<a name="line.24"></a>
  33. <span class="sourceLineNo">025</span><a name="line.25"></a>
  34. <span class="sourceLineNo">026</span>import org.apache.avro.reflect.Stringable;<a name="line.26"></a>
  35. <span class="sourceLineNo">027</span>import org.apache.commons.lang.StringUtils;<a name="line.27"></a>
  36. <span class="sourceLineNo">028</span>import org.apache.hadoop.HadoopIllegalArgumentException;<a name="line.28"></a>
  37. <span class="sourceLineNo">029</span>import org.apache.hadoop.classification.InterfaceAudience;<a name="line.29"></a>
  38. <span class="sourceLineNo">030</span>import org.apache.hadoop.classification.InterfaceStability;<a name="line.30"></a>
  39. <span class="sourceLineNo">031</span>import org.apache.hadoop.conf.Configuration;<a name="line.31"></a>
  40. <span class="sourceLineNo">032</span><a name="line.32"></a>
  41. <span class="sourceLineNo">033</span>/** Names a file or directory in a {@link FileSystem}.<a name="line.33"></a>
  42. <span class="sourceLineNo">034</span> * Path strings use slash as the directory separator. A path string is<a name="line.34"></a>
  43. <span class="sourceLineNo">035</span> * absolute if it begins with a slash.<a name="line.35"></a>
  44. <span class="sourceLineNo">036</span> */<a name="line.36"></a>
  45. <span class="sourceLineNo">037</span>@Stringable<a name="line.37"></a>
  46. <span class="sourceLineNo">038</span>@InterfaceAudience.Public<a name="line.38"></a>
  47. <span class="sourceLineNo">039</span>@InterfaceStability.Stable<a name="line.39"></a>
  48. <span class="sourceLineNo">040</span>public class Path implements Comparable {<a name="line.40"></a>
  49. <span class="sourceLineNo">041</span><a name="line.41"></a>
  50. <span class="sourceLineNo">042</span> /** The directory separator, a slash. */<a name="line.42"></a>
  51. <span class="sourceLineNo">043</span> public static final String SEPARATOR = "/";<a name="line.43"></a>
  52. <span class="sourceLineNo">044</span> public static final char SEPARATOR_CHAR = '/';<a name="line.44"></a>
  53. <span class="sourceLineNo">045</span> <a name="line.45"></a>
  54. <span class="sourceLineNo">046</span> public static final String CUR_DIR = ".";<a name="line.46"></a>
  55. <span class="sourceLineNo">047</span> <a name="line.47"></a>
  56. <span class="sourceLineNo">048</span> public static final boolean WINDOWS<a name="line.48"></a>
  57. <span class="sourceLineNo">049</span> = System.getProperty("os.name").startsWith("Windows");<a name="line.49"></a>
  58. <span class="sourceLineNo">050</span><a name="line.50"></a>
  59. <span class="sourceLineNo">051</span> /**<a name="line.51"></a>
  60. <span class="sourceLineNo">052</span> * Pre-compiled regular expressions to detect path formats.<a name="line.52"></a>
  61. <span class="sourceLineNo">053</span> */<a name="line.53"></a>
  62. <span class="sourceLineNo">054</span> private static final Pattern hasUriScheme =<a name="line.54"></a>
  63. <span class="sourceLineNo">055</span> Pattern.compile("^[a-zA-Z][a-zA-Z0-9+-.]+:");<a name="line.55"></a>
  64. <span class="sourceLineNo">056</span> private static final Pattern hasDriveLetterSpecifier =<a name="line.56"></a>
  65. <span class="sourceLineNo">057</span> Pattern.compile("^/?[a-zA-Z]:");<a name="line.57"></a>
  66. <span class="sourceLineNo">058</span><a name="line.58"></a>
  67. <span class="sourceLineNo">059</span> private URI uri; // a hierarchical uri<a name="line.59"></a>
  68. <span class="sourceLineNo">060</span><a name="line.60"></a>
  69. <span class="sourceLineNo">061</span> /**<a name="line.61"></a>
  70. <span class="sourceLineNo">062</span> * Pathnames with scheme and relative path are illegal.<a name="line.62"></a>
  71. <span class="sourceLineNo">063</span> * @param path to be checked<a name="line.63"></a>
  72. <span class="sourceLineNo">064</span> */<a name="line.64"></a>
  73. <span class="sourceLineNo">065</span> void checkNotSchemeWithRelative() {<a name="line.65"></a>
  74. <span class="sourceLineNo">066</span> if (toUri().isAbsolute() &amp;&amp; !isUriPathAbsolute()) {<a name="line.66"></a>
  75. <span class="sourceLineNo">067</span> throw new HadoopIllegalArgumentException(<a name="line.67"></a>
  76. <span class="sourceLineNo">068</span> "Unsupported name: has scheme but relative path-part");<a name="line.68"></a>
  77. <span class="sourceLineNo">069</span> }<a name="line.69"></a>
  78. <span class="sourceLineNo">070</span> }<a name="line.70"></a>
  79. <span class="sourceLineNo">071</span><a name="line.71"></a>
  80. <span class="sourceLineNo">072</span> void checkNotRelative() {<a name="line.72"></a>
  81. <span class="sourceLineNo">073</span> if (!isAbsolute() &amp;&amp; toUri().getScheme() == null) {<a name="line.73"></a>
  82. <span class="sourceLineNo">074</span> throw new HadoopIllegalArgumentException("Path is relative");<a name="line.74"></a>
  83. <span class="sourceLineNo">075</span> }<a name="line.75"></a>
  84. <span class="sourceLineNo">076</span> }<a name="line.76"></a>
  85. <span class="sourceLineNo">077</span><a name="line.77"></a>
  86. <span class="sourceLineNo">078</span> public static Path getPathWithoutSchemeAndAuthority(Path path) {<a name="line.78"></a>
  87. <span class="sourceLineNo">079</span> // This code depends on Path.toString() to remove the leading slash before<a name="line.79"></a>
  88. <span class="sourceLineNo">080</span> // the drive specification on Windows.<a name="line.80"></a>
  89. <span class="sourceLineNo">081</span> Path newPath = path.isUriPathAbsolute() ?<a name="line.81"></a>
  90. <span class="sourceLineNo">082</span> new Path(null, null, path.toUri().getPath()) :<a name="line.82"></a>
  91. <span class="sourceLineNo">083</span> path;<a name="line.83"></a>
  92. <span class="sourceLineNo">084</span> return newPath;<a name="line.84"></a>
  93. <span class="sourceLineNo">085</span> }<a name="line.85"></a>
  94. <span class="sourceLineNo">086</span><a name="line.86"></a>
  95. <span class="sourceLineNo">087</span> /** Resolve a child path against a parent path. */<a name="line.87"></a>
  96. <span class="sourceLineNo">088</span> public Path(String parent, String child) {<a name="line.88"></a>
  97. <span class="sourceLineNo">089</span> this(new Path(parent), new Path(child));<a name="line.89"></a>
  98. <span class="sourceLineNo">090</span> }<a name="line.90"></a>
  99. <span class="sourceLineNo">091</span><a name="line.91"></a>
  100. <span class="sourceLineNo">092</span> /** Resolve a child path against a parent path. */<a name="line.92"></a>
  101. <span class="sourceLineNo">093</span> public Path(Path parent, String child) {<a name="line.93"></a>
  102. <span class="sourceLineNo">094</span> this(parent, new Path(child));<a name="line.94"></a>
  103. <span class="sourceLineNo">095</span> }<a name="line.95"></a>
  104. <span class="sourceLineNo">096</span><a name="line.96"></a>
  105. <span class="sourceLineNo">097</span> /** Resolve a child path against a parent path. */<a name="line.97"></a>
  106. <span class="sourceLineNo">098</span> public Path(String parent, Path child) {<a name="line.98"></a>
  107. <span class="sourceLineNo">099</span> this(new Path(parent), child);<a name="line.99"></a>
  108. <span class="sourceLineNo">100</span> }<a name="line.100"></a>
  109. <span class="sourceLineNo">101</span><a name="line.101"></a>
  110. <span class="sourceLineNo">102</span> /** Resolve a child path against a parent path. */<a name="line.102"></a>
  111. <span class="sourceLineNo">103</span> public Path(Path parent, Path child) {<a name="line.103"></a>
  112. <span class="sourceLineNo">104</span> // Add a slash to parent's path so resolution is compatible with URI's<a name="line.104"></a>
  113. <span class="sourceLineNo">105</span> URI parentUri = parent.uri;<a name="line.105"></a>
  114. <span class="sourceLineNo">106</span> String parentPath = parentUri.getPath();<a name="line.106"></a>
  115. <span class="sourceLineNo">107</span> if (!(parentPath.equals("/") || parentPath.isEmpty())) {<a name="line.107"></a>
  116. <span class="sourceLineNo">108</span> try {<a name="line.108"></a>
  117. <span class="sourceLineNo">109</span> parentUri = new URI(parentUri.getScheme(), parentUri.getAuthority(),<a name="line.109"></a>
  118. <span class="sourceLineNo">110</span> parentUri.getPath()+"/", null, parentUri.getFragment());<a name="line.110"></a>
  119. <span class="sourceLineNo">111</span> } catch (URISyntaxException e) {<a name="line.111"></a>
  120. <span class="sourceLineNo">112</span> throw new IllegalArgumentException(e);<a name="line.112"></a>
  121. <span class="sourceLineNo">113</span> }<a name="line.113"></a>
  122. <span class="sourceLineNo">114</span> }<a name="line.114"></a>
  123. <span class="sourceLineNo">115</span> URI resolved = parentUri.resolve(child.uri);<a name="line.115"></a>
  124. <span class="sourceLineNo">116</span> initialize(resolved.getScheme(), resolved.getAuthority(),<a name="line.116"></a>
  125. <span class="sourceLineNo">117</span> resolved.getPath(), resolved.getFragment());<a name="line.117"></a>
  126. <span class="sourceLineNo">118</span> }<a name="line.118"></a>
  127. <span class="sourceLineNo">119</span><a name="line.119"></a>
  128. <span class="sourceLineNo">120</span> private void checkPathArg( String path ) throws IllegalArgumentException {<a name="line.120"></a>
  129. <span class="sourceLineNo">121</span> // disallow construction of a Path from an empty string<a name="line.121"></a>
  130. <span class="sourceLineNo">122</span> if ( path == null ) {<a name="line.122"></a>
  131. <span class="sourceLineNo">123</span> throw new IllegalArgumentException(<a name="line.123"></a>
  132. <span class="sourceLineNo">124</span> "Can not create a Path from a null string");<a name="line.124"></a>
  133. <span class="sourceLineNo">125</span> }<a name="line.125"></a>
  134. <span class="sourceLineNo">126</span> if( path.length() == 0 ) {<a name="line.126"></a>
  135. <span class="sourceLineNo">127</span> throw new IllegalArgumentException(<a name="line.127"></a>
  136. <span class="sourceLineNo">128</span> "Can not create a Path from an empty string");<a name="line.128"></a>
  137. <span class="sourceLineNo">129</span> } <a name="line.129"></a>
  138. <span class="sourceLineNo">130</span> }<a name="line.130"></a>
  139. <span class="sourceLineNo">131</span> <a name="line.131"></a>
  140. <span class="sourceLineNo">132</span> /** Construct a path from a String. Path strings are URIs, but with<a name="line.132"></a>
  141. <span class="sourceLineNo">133</span> * unescaped elements and some additional normalization. */<a name="line.133"></a>
  142. <span class="sourceLineNo">134</span> public Path(String pathString) throws IllegalArgumentException {<a name="line.134"></a>
  143. <span class="sourceLineNo">135</span> checkPathArg( pathString );<a name="line.135"></a>
  144. <span class="sourceLineNo">136</span> <a name="line.136"></a>
  145. <span class="sourceLineNo">137</span> // We can't use 'new URI(String)' directly, since it assumes things are<a name="line.137"></a>
  146. <span class="sourceLineNo">138</span> // escaped, which we don't require of Paths. <a name="line.138"></a>
  147. <span class="sourceLineNo">139</span> <a name="line.139"></a>
  148. <span class="sourceLineNo">140</span> // add a slash in front of paths with Windows drive letters<a name="line.140"></a>
  149. <span class="sourceLineNo">141</span> if (hasWindowsDrive(pathString) &amp;&amp; pathString.charAt(0) != '/') {<a name="line.141"></a>
  150. <span class="sourceLineNo">142</span> pathString = "/" + pathString;<a name="line.142"></a>
  151. <span class="sourceLineNo">143</span> }<a name="line.143"></a>
  152. <span class="sourceLineNo">144</span><a name="line.144"></a>
  153. <span class="sourceLineNo">145</span> // parse uri components<a name="line.145"></a>
  154. <span class="sourceLineNo">146</span> String scheme = null;<a name="line.146"></a>
  155. <span class="sourceLineNo">147</span> String authority = null;<a name="line.147"></a>
  156. <span class="sourceLineNo">148</span><a name="line.148"></a>
  157. <span class="sourceLineNo">149</span> int start = 0;<a name="line.149"></a>
  158. <span class="sourceLineNo">150</span><a name="line.150"></a>
  159. <span class="sourceLineNo">151</span> // parse uri scheme, if any<a name="line.151"></a>
  160. <span class="sourceLineNo">152</span> int colon = pathString.indexOf(':');<a name="line.152"></a>
  161. <span class="sourceLineNo">153</span> int slash = pathString.indexOf('/');<a name="line.153"></a>
  162. <span class="sourceLineNo">154</span> if ((colon != -1) &amp;&amp;<a name="line.154"></a>
  163. <span class="sourceLineNo">155</span> ((slash == -1) || (colon &lt; slash))) { // has a scheme<a name="line.155"></a>
  164. <span class="sourceLineNo">156</span> scheme = pathString.substring(0, colon);<a name="line.156"></a>
  165. <span class="sourceLineNo">157</span> start = colon+1;<a name="line.157"></a>
  166. <span class="sourceLineNo">158</span> }<a name="line.158"></a>
  167. <span class="sourceLineNo">159</span><a name="line.159"></a>
  168. <span class="sourceLineNo">160</span> // parse uri authority, if any<a name="line.160"></a>
  169. <span class="sourceLineNo">161</span> if (pathString.startsWith("//", start) &amp;&amp;<a name="line.161"></a>
  170. <span class="sourceLineNo">162</span> (pathString.length()-start &gt; 2)) { // has authority<a name="line.162"></a>
  171. <span class="sourceLineNo">163</span> int nextSlash = pathString.indexOf('/', start+2);<a name="line.163"></a>
  172. <span class="sourceLineNo">164</span> int authEnd = nextSlash &gt; 0 ? nextSlash : pathString.length();<a name="line.164"></a>
  173. <span class="sourceLineNo">165</span> authority = pathString.substring(start+2, authEnd);<a name="line.165"></a>
  174. <span class="sourceLineNo">166</span> start = authEnd;<a name="line.166"></a>
  175. <span class="sourceLineNo">167</span> }<a name="line.167"></a>
  176. <span class="sourceLineNo">168</span><a name="line.168"></a>
  177. <span class="sourceLineNo">169</span> // uri path is the rest of the string -- query &amp; fragment not supported<a name="line.169"></a>
  178. <span class="sourceLineNo">170</span> String path = pathString.substring(start, pathString.length());<a name="line.170"></a>
  179. <span class="sourceLineNo">171</span><a name="line.171"></a>
  180. <span class="sourceLineNo">172</span> initialize(scheme, authority, path, null);<a name="line.172"></a>
  181. <span class="sourceLineNo">173</span> }<a name="line.173"></a>
  182. <span class="sourceLineNo">174</span><a name="line.174"></a>
  183. <span class="sourceLineNo">175</span> /**<a name="line.175"></a>
  184. <span class="sourceLineNo">176</span> * Construct a path from a URI<a name="line.176"></a>
  185. <span class="sourceLineNo">177</span> */<a name="line.177"></a>
  186. <span class="sourceLineNo">178</span> public Path(URI aUri) {<a name="line.178"></a>
  187. <span class="sourceLineNo">179</span> uri = aUri.normalize();<a name="line.179"></a>
  188. <span class="sourceLineNo">180</span> }<a name="line.180"></a>
  189. <span class="sourceLineNo">181</span> <a name="line.181"></a>
  190. <span class="sourceLineNo">182</span> /** Construct a Path from components. */<a name="line.182"></a>
  191. <span class="sourceLineNo">183</span> public Path(String scheme, String authority, String path) {<a name="line.183"></a>
  192. <span class="sourceLineNo">184</span> checkPathArg( path );<a name="line.184"></a>
  193. <span class="sourceLineNo">185</span><a name="line.185"></a>
  194. <span class="sourceLineNo">186</span> // add a slash in front of paths with Windows drive letters<a name="line.186"></a>
  195. <span class="sourceLineNo">187</span> if (hasWindowsDrive(path) &amp;&amp; path.charAt(0) != '/') {<a name="line.187"></a>
  196. <span class="sourceLineNo">188</span> path = "/" + path;<a name="line.188"></a>
  197. <span class="sourceLineNo">189</span> }<a name="line.189"></a>
  198. <span class="sourceLineNo">190</span><a name="line.190"></a>
  199. <span class="sourceLineNo">191</span> // add "./" in front of Linux relative paths so that a path containing<a name="line.191"></a>
  200. <span class="sourceLineNo">192</span> // a colon e.q. "a:b" will not be interpreted as scheme "a".<a name="line.192"></a>
  201. <span class="sourceLineNo">193</span> if (!WINDOWS &amp;&amp; path.charAt(0) != '/') {<a name="line.193"></a>
  202. <span class="sourceLineNo">194</span> path = "./" + path;<a name="line.194"></a>
  203. <span class="sourceLineNo">195</span> }<a name="line.195"></a>
  204. <span class="sourceLineNo">196</span><a name="line.196"></a>
  205. <span class="sourceLineNo">197</span> initialize(scheme, authority, path, null);<a name="line.197"></a>
  206. <span class="sourceLineNo">198</span> }<a name="line.198"></a>
  207. <span class="sourceLineNo">199</span><a name="line.199"></a>
  208. <span class="sourceLineNo">200</span> private void initialize(String scheme, String authority, String path,<a name="line.200"></a>
  209. <span class="sourceLineNo">201</span> String fragment) {<a name="line.201"></a>
  210. <span class="sourceLineNo">202</span> try {<a name="line.202"></a>
  211. <span class="sourceLineNo">203</span> this.uri = new URI(scheme, authority, normalizePath(scheme, path), null, fragment)<a name="line.203"></a>
  212. <span class="sourceLineNo">204</span> .normalize();<a name="line.204"></a>
  213. <span class="sourceLineNo">205</span> } catch (URISyntaxException e) {<a name="line.205"></a>
  214. <span class="sourceLineNo">206</span> throw new IllegalArgumentException(e);<a name="line.206"></a>
  215. <span class="sourceLineNo">207</span> }<a name="line.207"></a>
  216. <span class="sourceLineNo">208</span> }<a name="line.208"></a>
  217. <span class="sourceLineNo">209</span><a name="line.209"></a>
  218. <span class="sourceLineNo">210</span> /**<a name="line.210"></a>
  219. <span class="sourceLineNo">211</span> * Merge 2 paths such that the second path is appended relative to the first.<a name="line.211"></a>
  220. <span class="sourceLineNo">212</span> * The returned path has the scheme and authority of the first path. On<a name="line.212"></a>
  221. <span class="sourceLineNo">213</span> * Windows, the drive specification in the second path is discarded.<a name="line.213"></a>
  222. <span class="sourceLineNo">214</span> * <a name="line.214"></a>
  223. <span class="sourceLineNo">215</span> * @param path1 Path first path<a name="line.215"></a>
  224. <span class="sourceLineNo">216</span> * @param path2 Path second path, to be appended relative to path1<a name="line.216"></a>
  225. <span class="sourceLineNo">217</span> * @return Path merged path<a name="line.217"></a>
  226. <span class="sourceLineNo">218</span> */<a name="line.218"></a>
  227. <span class="sourceLineNo">219</span> public static Path mergePaths(Path path1, Path path2) {<a name="line.219"></a>
  228. <span class="sourceLineNo">220</span> String path2Str = path2.toUri().getPath();<a name="line.220"></a>
  229. <span class="sourceLineNo">221</span> path2Str = path2Str.substring(startPositionWithoutWindowsDrive(path2Str));<a name="line.221"></a>
  230. <span class="sourceLineNo">222</span> // Add path components explicitly, because simply concatenating two path<a name="line.222"></a>
  231. <span class="sourceLineNo">223</span> // string is not safe, for example:<a name="line.223"></a>
  232. <span class="sourceLineNo">224</span> // "/" + "/foo" yields "//foo", which will be parsed as authority in Path<a name="line.224"></a>
  233. <span class="sourceLineNo">225</span> return new Path(path1.toUri().getScheme(), <a name="line.225"></a>
  234. <span class="sourceLineNo">226</span> path1.toUri().getAuthority(), <a name="line.226"></a>
  235. <span class="sourceLineNo">227</span> path1.toUri().getPath() + path2Str);<a name="line.227"></a>
  236. <span class="sourceLineNo">228</span> }<a name="line.228"></a>
  237. <span class="sourceLineNo">229</span><a name="line.229"></a>
  238. <span class="sourceLineNo">230</span> /**<a name="line.230"></a>
  239. <span class="sourceLineNo">231</span> * Normalize a path string to use non-duplicated forward slashes as<a name="line.231"></a>
  240. <span class="sourceLineNo">232</span> * the path separator and remove any trailing path separators.<a name="line.232"></a>
  241. <span class="sourceLineNo">233</span> * @param scheme Supplies the URI scheme. Used to deduce whether we<a name="line.233"></a>
  242. <span class="sourceLineNo">234</span> * should replace backslashes or not.<a name="line.234"></a>
  243. <span class="sourceLineNo">235</span> * @param path Supplies the scheme-specific part<a name="line.235"></a>
  244. <span class="sourceLineNo">236</span> * @return Normalized path string.<a name="line.236"></a>
  245. <span class="sourceLineNo">237</span> */<a name="line.237"></a>
  246. <span class="sourceLineNo">238</span> private static String normalizePath(String scheme, String path) {<a name="line.238"></a>
  247. <span class="sourceLineNo">239</span> // Remove double forward slashes.<a name="line.239"></a>
  248. <span class="sourceLineNo">240</span> path = StringUtils.replace(path, "//", "/");<a name="line.240"></a>
  249. <span class="sourceLineNo">241</span><a name="line.241"></a>
  250. <span class="sourceLineNo">242</span> // Remove backslashes if this looks like a Windows path. Avoid<a name="line.242"></a>
  251. <span class="sourceLineNo">243</span> // the substitution if it looks like a non-local URI.<a name="line.243"></a>
  252. <span class="sourceLineNo">244</span> if (WINDOWS &amp;&amp;<a name="line.244"></a>
  253. <span class="sourceLineNo">245</span> (hasWindowsDrive(path) ||<a name="line.245"></a>
  254. <span class="sourceLineNo">246</span> (scheme == null) ||<a name="line.246"></a>
  255. <span class="sourceLineNo">247</span> (scheme.isEmpty()) ||<a name="line.247"></a>
  256. <span class="sourceLineNo">248</span> (scheme.equals("file")))) {<a name="line.248"></a>
  257. <span class="sourceLineNo">249</span> path = StringUtils.replace(path, "\\", "/");<a name="line.249"></a>
  258. <span class="sourceLineNo">250</span> }<a name="line.250"></a>
  259. <span class="sourceLineNo">251</span> <a name="line.251"></a>
  260. <span class="sourceLineNo">252</span> // trim trailing slash from non-root path (ignoring windows drive)<a name="line.252"></a>
  261. <span class="sourceLineNo">253</span> int minLength = startPositionWithoutWindowsDrive(path) + 1;<a name="line.253"></a>
  262. <span class="sourceLineNo">254</span> if (path.length() &gt; minLength &amp;&amp; path.endsWith(SEPARATOR)) {<a name="line.254"></a>
  263. <span class="sourceLineNo">255</span> path = path.substring(0, path.length()-1);<a name="line.255"></a>
  264. <span class="sourceLineNo">256</span> }<a name="line.256"></a>
  265. <span class="sourceLineNo">257</span> <a name="line.257"></a>
  266. <span class="sourceLineNo">258</span> return path;<a name="line.258"></a>
  267. <span class="sourceLineNo">259</span> }<a name="line.259"></a>
  268. <span class="sourceLineNo">260</span><a name="line.260"></a>
  269. <span class="sourceLineNo">261</span> private static boolean hasWindowsDrive(String path) {<a name="line.261"></a>
  270. <span class="sourceLineNo">262</span> return (WINDOWS &amp;&amp; hasDriveLetterSpecifier.matcher(path).find());<a name="line.262"></a>
  271. <span class="sourceLineNo">263</span> }<a name="line.263"></a>
  272. <span class="sourceLineNo">264</span><a name="line.264"></a>
  273. <span class="sourceLineNo">265</span> private static int startPositionWithoutWindowsDrive(String path) {<a name="line.265"></a>
  274. <span class="sourceLineNo">266</span> if (hasWindowsDrive(path)) {<a name="line.266"></a>
  275. <span class="sourceLineNo">267</span> return path.charAt(0) == SEPARATOR_CHAR ? 3 : 2;<a name="line.267"></a>
  276. <span class="sourceLineNo">268</span> } else {<a name="line.268"></a>
  277. <span class="sourceLineNo">269</span> return 0;<a name="line.269"></a>
  278. <span class="sourceLineNo">270</span> }<a name="line.270"></a>
  279. <span class="sourceLineNo">271</span> }<a name="line.271"></a>
  280. <span class="sourceLineNo">272</span> <a name="line.272"></a>
  281. <span class="sourceLineNo">273</span> /**<a name="line.273"></a>
  282. <span class="sourceLineNo">274</span> * Determine whether a given path string represents an absolute path on<a name="line.274"></a>
  283. <span class="sourceLineNo">275</span> * Windows. e.g. "C:/a/b" is an absolute path. "C:a/b" is not.<a name="line.275"></a>
  284. <span class="sourceLineNo">276</span> *<a name="line.276"></a>
  285. <span class="sourceLineNo">277</span> * @param pathString Supplies the path string to evaluate.<a name="line.277"></a>
  286. <span class="sourceLineNo">278</span> * @param slashed true if the given path is prefixed with "/".<a name="line.278"></a>
  287. <span class="sourceLineNo">279</span> * @return true if the supplied path looks like an absolute path with a Windows<a name="line.279"></a>
  288. <span class="sourceLineNo">280</span> * drive-specifier.<a name="line.280"></a>
  289. <span class="sourceLineNo">281</span> */<a name="line.281"></a>
  290. <span class="sourceLineNo">282</span> public static boolean isWindowsAbsolutePath(final String pathString,<a name="line.282"></a>
  291. <span class="sourceLineNo">283</span> final boolean slashed) {<a name="line.283"></a>
  292. <span class="sourceLineNo">284</span> int start = startPositionWithoutWindowsDrive(pathString);<a name="line.284"></a>
  293. <span class="sourceLineNo">285</span> return start &gt; 0<a name="line.285"></a>
  294. <span class="sourceLineNo">286</span> &amp;&amp; pathString.length() &gt; start<a name="line.286"></a>
  295. <span class="sourceLineNo">287</span> &amp;&amp; ((pathString.charAt(start) == SEPARATOR_CHAR) ||<a name="line.287"></a>
  296. <span class="sourceLineNo">288</span> (pathString.charAt(start) == '\\'));<a name="line.288"></a>
  297. <span class="sourceLineNo">289</span> }<a name="line.289"></a>
  298. <span class="sourceLineNo">290</span><a name="line.290"></a>
  299. <span class="sourceLineNo">291</span> /** Convert this to a URI. */<a name="line.291"></a>
  300. <span class="sourceLineNo">292</span> public URI toUri() { return uri; }<a name="line.292"></a>
  301. <span class="sourceLineNo">293</span><a name="line.293"></a>
  302. <span class="sourceLineNo">294</span> /** Return the FileSystem that owns this Path. */<a name="line.294"></a>
  303. <span class="sourceLineNo">295</span> public FileSystem getFileSystem(Configuration conf) throws IOException {<a name="line.295"></a>
  304. <span class="sourceLineNo">296</span> return FileSystem.get(this.toUri(), conf);<a name="line.296"></a>
  305. <span class="sourceLineNo">297</span> }<a name="line.297"></a>
  306. <span class="sourceLineNo">298</span><a name="line.298"></a>
  307. <span class="sourceLineNo">299</span> /**<a name="line.299"></a>
  308. <span class="sourceLineNo">300</span> * Is an absolute path (ie a slash relative path part)<a name="line.300"></a>
  309. <span class="sourceLineNo">301</span> * AND a scheme is null AND authority is null.<a name="line.301"></a>
  310. <span class="sourceLineNo">302</span> */<a name="line.302"></a>
  311. <span class="sourceLineNo">303</span> public boolean isAbsoluteAndSchemeAuthorityNull() {<a name="line.303"></a>
  312. <span class="sourceLineNo">304</span> return (isUriPathAbsolute() &amp;&amp; <a name="line.304"></a>
  313. <span class="sourceLineNo">305</span> uri.getScheme() == null &amp;&amp; uri.getAuthority() == null);<a name="line.305"></a>
  314. <span class="sourceLineNo">306</span> }<a name="line.306"></a>
  315. <span class="sourceLineNo">307</span> <a name="line.307"></a>
  316. <span class="sourceLineNo">308</span> /**<a name="line.308"></a>
  317. <span class="sourceLineNo">309</span> * True if the path component (i.e. directory) of this URI is absolute.<a name="line.309"></a>
  318. <span class="sourceLineNo">310</span> */<a name="line.310"></a>
  319. <span class="sourceLineNo">311</span> public boolean isUriPathAbsolute() {<a name="line.311"></a>
  320. <span class="sourceLineNo">312</span> int start = startPositionWithoutWindowsDrive(uri.getPath());<a name="line.312"></a>
  321. <span class="sourceLineNo">313</span> return uri.getPath().startsWith(SEPARATOR, start);<a name="line.313"></a>
  322. <span class="sourceLineNo">314</span> }<a name="line.314"></a>
  323. <span class="sourceLineNo">315</span> <a name="line.315"></a>
  324. <span class="sourceLineNo">316</span> /** True if the path component of this URI is absolute. */<a name="line.316"></a>
  325. <span class="sourceLineNo">317</span> /**<a name="line.317"></a>
  326. <span class="sourceLineNo">318</span> * There is some ambiguity here. An absolute path is a slash<a name="line.318"></a>
  327. <span class="sourceLineNo">319</span> * relative name without a scheme or an authority.<a name="line.319"></a>
  328. <span class="sourceLineNo">320</span> * So either this method was incorrectly named or its<a name="line.320"></a>
  329. <span class="sourceLineNo">321</span> * implementation is incorrect. This method returns true<a name="line.321"></a>
  330. <span class="sourceLineNo">322</span> * even if there is a scheme and authority.<a name="line.322"></a>
  331. <span class="sourceLineNo">323</span> */<a name="line.323"></a>
  332. <span class="sourceLineNo">324</span> public boolean isAbsolute() {<a name="line.324"></a>
  333. <span class="sourceLineNo">325</span> return isUriPathAbsolute();<a name="line.325"></a>
  334. <span class="sourceLineNo">326</span> }<a name="line.326"></a>
  335. <span class="sourceLineNo">327</span><a name="line.327"></a>
  336. <span class="sourceLineNo">328</span> /**<a name="line.328"></a>
  337. <span class="sourceLineNo">329</span> * @return true if and only if this path represents the root of a file system<a name="line.329"></a>
  338. <span class="sourceLineNo">330</span> */<a name="line.330"></a>
  339. <span class="sourceLineNo">331</span> public boolean isRoot() {<a name="line.331"></a>
  340. <span class="sourceLineNo">332</span> return getParent() == null;<a name="line.332"></a>
  341. <span class="sourceLineNo">333</span> }<a name="line.333"></a>
  342. <span class="sourceLineNo">334</span><a name="line.334"></a>
  343. <span class="sourceLineNo">335</span> /** Returns the final component of this path.*/<a name="line.335"></a>
  344. <span class="sourceLineNo">336</span> public String getName() {<a name="line.336"></a>
  345. <span class="sourceLineNo">337</span> String path = uri.getPath();<a name="line.337"></a>
  346. <span class="sourceLineNo">338</span> int slash = path.lastIndexOf(SEPARATOR);<a name="line.338"></a>
  347. <span class="sourceLineNo">339</span> return path.substring(slash+1);<a name="line.339"></a>
  348. <span class="sourceLineNo">340</span> }<a name="line.340"></a>
  349. <span class="sourceLineNo">341</span><a name="line.341"></a>
  350. <span class="sourceLineNo">342</span> /** Returns the parent of a path or null if at root. */<a name="line.342"></a>
  351. <span class="sourceLineNo">343</span> public Path getParent() {<a name="line.343"></a>
  352. <span class="sourceLineNo">344</span> String path = uri.getPath();<a name="line.344"></a>
  353. <span class="sourceLineNo">345</span> int lastSlash = path.lastIndexOf('/');<a name="line.345"></a>
  354. <span class="sourceLineNo">346</span> int start = startPositionWithoutWindowsDrive(path);<a name="line.346"></a>
  355. <span class="sourceLineNo">347</span> if ((path.length() == start) || // empty path<a name="line.347"></a>
  356. <span class="sourceLineNo">348</span> (lastSlash == start &amp;&amp; path.length() == start+1)) { // at root<a name="line.348"></a>
  357. <span class="sourceLineNo">349</span> return null;<a name="line.349"></a>
  358. <span class="sourceLineNo">350</span> }<a name="line.350"></a>
  359. <span class="sourceLineNo">351</span> String parent;<a name="line.351"></a>
  360. <span class="sourceLineNo">352</span> if (lastSlash==-1) {<a name="line.352"></a>
  361. <span class="sourceLineNo">353</span> parent = CUR_DIR;<a name="line.353"></a>
  362. <span class="sourceLineNo">354</span> } else {<a name="line.354"></a>
  363. <span class="sourceLineNo">355</span> parent = path.substring(0, lastSlash==start?start+1:lastSlash);<a name="line.355"></a>
  364. <span class="sourceLineNo">356</span> }<a name="line.356"></a>
  365. <span class="sourceLineNo">357</span> return new Path(uri.getScheme(), uri.getAuthority(), parent);<a name="line.357"></a>
  366. <span class="sourceLineNo">358</span> }<a name="line.358"></a>
  367. <span class="sourceLineNo">359</span><a name="line.359"></a>
  368. <span class="sourceLineNo">360</span> /** Adds a suffix to the final name in the path.*/<a name="line.360"></a>
  369. <span class="sourceLineNo">361</span> public Path suffix(String suffix) {<a name="line.361"></a>
  370. <span class="sourceLineNo">362</span> return new Path(getParent(), getName()+suffix);<a name="line.362"></a>
  371. <span class="sourceLineNo">363</span> }<a name="line.363"></a>
  372. <span class="sourceLineNo">364</span><a name="line.364"></a>
  373. <span class="sourceLineNo">365</span> @Override<a name="line.365"></a>
  374. <span class="sourceLineNo">366</span> public String toString() {<a name="line.366"></a>
  375. <span class="sourceLineNo">367</span> // we can't use uri.toString(), which escapes everything, because we want<a name="line.367"></a>
  376. <span class="sourceLineNo">368</span> // illegal characters unescaped in the string, for glob processing, etc.<a name="line.368"></a>
  377. <span class="sourceLineNo">369</span> StringBuilder buffer = new StringBuilder();<a name="line.369"></a>
  378. <span class="sourceLineNo">370</span> if (uri.getScheme() != null) {<a name="line.370"></a>
  379. <span class="sourceLineNo">371</span> buffer.append(uri.getScheme());<a name="line.371"></a>
  380. <span class="sourceLineNo">372</span> buffer.append(":");<a name="line.372"></a>
  381. <span class="sourceLineNo">373</span> }<a name="line.373"></a>
  382. <span class="sourceLineNo">374</span> if (uri.getAuthority() != null) {<a name="line.374"></a>
  383. <span class="sourceLineNo">375</span> buffer.append("//");<a name="line.375"></a>
  384. <span class="sourceLineNo">376</span> buffer.append(uri.getAuthority());<a name="line.376"></a>
  385. <span class="sourceLineNo">377</span> }<a name="line.377"></a>
  386. <span class="sourceLineNo">378</span> if (uri.getPath() != null) {<a name="line.378"></a>
  387. <span class="sourceLineNo">379</span> String path = uri.getPath();<a name="line.379"></a>
  388. <span class="sourceLineNo">380</span> if (path.indexOf('/')==0 &amp;&amp;<a name="line.380"></a>
  389. <span class="sourceLineNo">381</span> hasWindowsDrive(path) &amp;&amp; // has windows drive<a name="line.381"></a>
  390. <span class="sourceLineNo">382</span> uri.getScheme() == null &amp;&amp; // but no scheme<a name="line.382"></a>
  391. <span class="sourceLineNo">383</span> uri.getAuthority() == null) // or authority<a name="line.383"></a>
  392. <span class="sourceLineNo">384</span> path = path.substring(1); // remove slash before drive<a name="line.384"></a>
  393. <span class="sourceLineNo">385</span> buffer.append(path);<a name="line.385"></a>
  394. <span class="sourceLineNo">386</span> }<a name="line.386"></a>
  395. <span class="sourceLineNo">387</span> if (uri.getFragment() != null) {<a name="line.387"></a>
  396. <span class="sourceLineNo">388</span> buffer.append("#");<a name="line.388"></a>
  397. <span class="sourceLineNo">389</span> buffer.append(uri.getFragment());<a name="line.389"></a>
  398. <span class="sourceLineNo">390</span> }<a name="line.390"></a>
  399. <span class="sourceLineNo">391</span> return buffer.toString();<a name="line.391"></a>
  400. <span class="sourceLineNo">392</span> }<a name="line.392"></a>
  401. <span class="sourceLineNo">393</span><a name="line.393"></a>
  402. <span class="sourceLineNo">394</span> @Override<a name="line.394"></a>
  403. <span class="sourceLineNo">395</span> public boolean equals(Object o) {<a name="line.395"></a>
  404. <span class="sourceLineNo">396</span> if (!(o instanceof Path)) {<a name="line.396"></a>
  405. <span class="sourceLineNo">397</span> return false;<a name="line.397"></a>
  406. <span class="sourceLineNo">398</span> }<a name="line.398"></a>
  407. <span class="sourceLineNo">399</span> Path that = (Path)o;<a name="line.399"></a>
  408. <span class="sourceLineNo">400</span> return this.uri.equals(that.uri);<a name="line.400"></a>
  409. <span class="sourceLineNo">401</span> }<a name="line.401"></a>
  410. <span class="sourceLineNo">402</span><a name="line.402"></a>
  411. <span class="sourceLineNo">403</span> @Override<a name="line.403"></a>
  412. <span class="sourceLineNo">404</span> public int hashCode() {<a name="line.404"></a>
  413. <span class="sourceLineNo">405</span> return uri.hashCode();<a name="line.405"></a>
  414. <span class="sourceLineNo">406</span> }<a name="line.406"></a>
  415. <span class="sourceLineNo">407</span><a name="line.407"></a>
  416. <span class="sourceLineNo">408</span> @Override<a name="line.408"></a>
  417. <span class="sourceLineNo">409</span> public int compareTo(Object o) {<a name="line.409"></a>
  418. <span class="sourceLineNo">410</span> Path that = (Path)o;<a name="line.410"></a>
  419. <span class="sourceLineNo">411</span> return this.uri.compareTo(that.uri);<a name="line.411"></a>
  420. <span class="sourceLineNo">412</span> }<a name="line.412"></a>
  421. <span class="sourceLineNo">413</span> <a name="line.413"></a>
  422. <span class="sourceLineNo">414</span> /** Return the number of elements in this path. */<a name="line.414"></a>
  423. <span class="sourceLineNo">415</span> public int depth() {<a name="line.415"></a>
  424. <span class="sourceLineNo">416</span> String path = uri.getPath();<a name="line.416"></a>
  425. <span class="sourceLineNo">417</span> int depth = 0;<a name="line.417"></a>
  426. <span class="sourceLineNo">418</span> int slash = path.length()==1 &amp;&amp; path.charAt(0)=='/' ? -1 : 0;<a name="line.418"></a>
  427. <span class="sourceLineNo">419</span> while (slash != -1) {<a name="line.419"></a>
  428. <span class="sourceLineNo">420</span> depth++;<a name="line.420"></a>
  429. <span class="sourceLineNo">421</span> slash = path.indexOf(SEPARATOR, slash+1);<a name="line.421"></a>
  430. <span class="sourceLineNo">422</span> }<a name="line.422"></a>
  431. <span class="sourceLineNo">423</span> return depth;<a name="line.423"></a>
  432. <span class="sourceLineNo">424</span> }<a name="line.424"></a>
  433. <span class="sourceLineNo">425</span><a name="line.425"></a>
  434. <span class="sourceLineNo">426</span> /**<a name="line.426"></a>
  435. <span class="sourceLineNo">427</span> * Returns a qualified path object.<a name="line.427"></a>
  436. <span class="sourceLineNo">428</span> * <a name="line.428"></a>
  437. <span class="sourceLineNo">429</span> * Deprecated - use {@link #makeQualified(URI, Path)}<a name="line.429"></a>
  438. <span class="sourceLineNo">430</span> */<a name="line.430"></a>
  439. <span class="sourceLineNo">431</span> @Deprecated<a name="line.431"></a>
  440. <span class="sourceLineNo">432</span> public Path makeQualified(FileSystem fs) {<a name="line.432"></a>
  441. <span class="sourceLineNo">433</span> return makeQualified(fs.getUri(), fs.getWorkingDirectory());<a name="line.433"></a>
  442. <span class="sourceLineNo">434</span> }<a name="line.434"></a>
  443. <span class="sourceLineNo">435</span> <a name="line.435"></a>
  444. <span class="sourceLineNo">436</span> /** Returns a qualified path object. */<a name="line.436"></a>
  445. <span class="sourceLineNo">437</span> @InterfaceAudience.LimitedPrivate({"HDFS", "MapReduce"})<a name="line.437"></a>
  446. <span class="sourceLineNo">438</span> public Path makeQualified(URI defaultUri, Path workingDir ) {<a name="line.438"></a>
  447. <span class="sourceLineNo">439</span> Path path = this;<a name="line.439"></a>
  448. <span class="sourceLineNo">440</span> if (!isAbsolute()) {<a name="line.440"></a>
  449. <span class="sourceLineNo">441</span> path = new Path(workingDir, this);<a name="line.441"></a>
  450. <span class="sourceLineNo">442</span> }<a name="line.442"></a>
  451. <span class="sourceLineNo">443</span><a name="line.443"></a>
  452. <span class="sourceLineNo">444</span> URI pathUri = path.toUri();<a name="line.444"></a>
  453. <span class="sourceLineNo">445</span> <a name="line.445"></a>
  454. <span class="sourceLineNo">446</span> String scheme = pathUri.getScheme();<a name="line.446"></a>
  455. <span class="sourceLineNo">447</span> String authority = pathUri.getAuthority();<a name="line.447"></a>
  456. <span class="sourceLineNo">448</span> String fragment = pathUri.getFragment();<a name="line.448"></a>
  457. <span class="sourceLineNo">449</span><a name="line.449"></a>
  458. <span class="sourceLineNo">450</span> if (scheme != null &amp;&amp;<a name="line.450"></a>
  459. <span class="sourceLineNo">451</span> (authority != null || defaultUri.getAuthority() == null))<a name="line.451"></a>
  460. <span class="sourceLineNo">452</span> return path;<a name="line.452"></a>
  461. <span class="sourceLineNo">453</span><a name="line.453"></a>
  462. <span class="sourceLineNo">454</span> if (scheme == null) {<a name="line.454"></a>
  463. <span class="sourceLineNo">455</span> scheme = defaultUri.getScheme();<a name="line.455"></a>
  464. <span class="sourceLineNo">456</span> }<a name="line.456"></a>
  465. <span class="sourceLineNo">457</span><a name="line.457"></a>
  466. <span class="sourceLineNo">458</span> if (authority == null) {<a name="line.458"></a>
  467. <span class="sourceLineNo">459</span> authority = defaultUri.getAuthority();<a name="line.459"></a>
  468. <span class="sourceLineNo">460</span> if (authority == null) {<a name="line.460"></a>
  469. <span class="sourceLineNo">461</span> authority = "";<a name="line.461"></a>
  470. <span class="sourceLineNo">462</span> }<a name="line.462"></a>
  471. <span class="sourceLineNo">463</span> }<a name="line.463"></a>
  472. <span class="sourceLineNo">464</span> <a name="line.464"></a>
  473. <span class="sourceLineNo">465</span> URI newUri = null;<a name="line.465"></a>
  474. <span class="sourceLineNo">466</span> try {<a name="line.466"></a>
  475. <span class="sourceLineNo">467</span> newUri = new URI(scheme, authority , <a name="line.467"></a>
  476. <span class="sourceLineNo">468</span> normalizePath(scheme, pathUri.getPath()), null, fragment);<a name="line.468"></a>
  477. <span class="sourceLineNo">469</span> } catch (URISyntaxException e) {<a name="line.469"></a>
  478. <span class="sourceLineNo">470</span> throw new IllegalArgumentException(e);<a name="line.470"></a>
  479. <span class="sourceLineNo">471</span> }<a name="line.471"></a>
  480. <span class="sourceLineNo">472</span> return new Path(newUri);<a name="line.472"></a>
  481. <span class="sourceLineNo">473</span> }<a name="line.473"></a>
  482. <span class="sourceLineNo">474</span>}<a name="line.474"></a>
  483. </pre>
  484. </div>
  485. </body>
  486. </html>