IOCase.html 36 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="de">
  4. <head>
  5. <!-- Generated by javadoc -->
  6. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  7. <title>IOCase (Apache Commons IO 2.6 API)</title>
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="IOCase (Apache Commons IO 2.6 API)";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10,"i8":10,"i9":10,"i10":9,"i11":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/IOCase.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-all.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/apache/commons/io/HexDump.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/apache/commons/io/IOExceptionWithCause.html" title="class in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/apache/commons/io/IOCase.html" target="_top">Frames</a></li>
  57. <li><a href="IOCase.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
  79. <li>Field&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
  85. <li>Field&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.apache.commons.io</div>
  96. <h2 title="Enum IOCase" class="title">Enum IOCase</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
  101. <li>
  102. <ul class="inheritance">
  103. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a>&gt;</li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>org.apache.commons.io.IOCase</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a>&gt;</dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public enum <span class="typeNameLabel">IOCase</span>
  122. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a>&gt;
  123. implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
  124. <div class="block">Enumeration of IO case sensitivity.
  125. <p>
  126. Different filing systems have different rules for case-sensitivity.
  127. Windows is case-insensitive, Unix is case-sensitive.
  128. <p>
  129. This class captures that difference, providing an enumeration to
  130. control how filename comparisons should be performed. It also provides
  131. methods that use the enumeration to perform comparisons.
  132. <p>
  133. Wherever possible, you should use the <code>check</code> methods in this
  134. class to compare filenames.</div>
  135. <dl>
  136. <dt><span class="simpleTagLabel">Since:</span></dt>
  137. <dd>1.3</dd>
  138. </dl>
  139. </li>
  140. </ul>
  141. </div>
  142. <div class="summary">
  143. <ul class="blockList">
  144. <li class="blockList">
  145. <!-- =========== ENUM CONSTANT SUMMARY =========== -->
  146. <ul class="blockList">
  147. <li class="blockList"><a name="enum.constant.summary">
  148. <!-- -->
  149. </a>
  150. <h3>Enum Constant Summary</h3>
  151. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
  152. <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
  153. <tr>
  154. <th class="colOne" scope="col">Enum Constant and Description</th>
  155. </tr>
  156. <tr class="altColor">
  157. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#INSENSITIVE">INSENSITIVE</a></span></code>
  158. <div class="block">The constant for case insensitive regardless of operating system.</div>
  159. </td>
  160. </tr>
  161. <tr class="rowColor">
  162. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#SENSITIVE">SENSITIVE</a></span></code>
  163. <div class="block">The constant for case sensitive regardless of operating system.</div>
  164. </td>
  165. </tr>
  166. <tr class="altColor">
  167. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#SYSTEM">SYSTEM</a></span></code>
  168. <div class="block">The constant for case sensitivity determined by the current operating system.</div>
  169. </td>
  170. </tr>
  171. </table>
  172. </li>
  173. </ul>
  174. <!-- ========== METHOD SUMMARY =========== -->
  175. <ul class="blockList">
  176. <li class="blockList"><a name="method.summary">
  177. <!-- -->
  178. </a>
  179. <h3>Method Summary</h3>
  180. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  181. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  182. <tr>
  183. <th class="colFirst" scope="col">Modifier and Type</th>
  184. <th class="colLast" scope="col">Method and Description</th>
  185. </tr>
  186. <tr id="i0" class="altColor">
  187. <td class="colFirst"><code>int</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#checkCompareTo-java.lang.String-java.lang.String-">checkCompareTo</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str1,
  189. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str2)</code>
  190. <div class="block">Compares two strings using the case-sensitivity rule.</div>
  191. </td>
  192. </tr>
  193. <tr id="i1" class="rowColor">
  194. <td class="colFirst"><code>boolean</code></td>
  195. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#checkEndsWith-java.lang.String-java.lang.String-">checkEndsWith</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str,
  196. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;end)</code>
  197. <div class="block">Checks if one string ends with another using the case-sensitivity rule.</div>
  198. </td>
  199. </tr>
  200. <tr id="i2" class="altColor">
  201. <td class="colFirst"><code>boolean</code></td>
  202. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#checkEquals-java.lang.String-java.lang.String-">checkEquals</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str1,
  203. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str2)</code>
  204. <div class="block">Compares two strings using the case-sensitivity rule.</div>
  205. </td>
  206. </tr>
  207. <tr id="i3" class="rowColor">
  208. <td class="colFirst"><code>int</code></td>
  209. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#checkIndexOf-java.lang.String-int-java.lang.String-">checkIndexOf</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str,
  210. int&nbsp;strStartIndex,
  211. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;search)</code>
  212. <div class="block">Checks if one string contains another starting at a specific index using the
  213. case-sensitivity rule.</div>
  214. </td>
  215. </tr>
  216. <tr id="i4" class="altColor">
  217. <td class="colFirst"><code>boolean</code></td>
  218. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#checkRegionMatches-java.lang.String-int-java.lang.String-">checkRegionMatches</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str,
  219. int&nbsp;strStartIndex,
  220. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;search)</code>
  221. <div class="block">Checks if one string contains another at a specific index using the case-sensitivity rule.</div>
  222. </td>
  223. </tr>
  224. <tr id="i5" class="rowColor">
  225. <td class="colFirst"><code>boolean</code></td>
  226. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#checkStartsWith-java.lang.String-java.lang.String-">checkStartsWith</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str,
  227. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;start)</code>
  228. <div class="block">Checks if one string starts with another using the case-sensitivity rule.</div>
  229. </td>
  230. </tr>
  231. <tr id="i6" class="altColor">
  232. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a></code></td>
  233. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#forName-java.lang.String-">forName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
  234. <div class="block">Factory method to create an IOCase from a name.</div>
  235. </td>
  236. </tr>
  237. <tr id="i7" class="rowColor">
  238. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  239. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#getName--">getName</a></span>()</code>
  240. <div class="block">Gets the name of the constant.</div>
  241. </td>
  242. </tr>
  243. <tr id="i8" class="altColor">
  244. <td class="colFirst"><code>boolean</code></td>
  245. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#isCaseSensitive--">isCaseSensitive</a></span>()</code>
  246. <div class="block">Does the object represent case sensitive comparison.</div>
  247. </td>
  248. </tr>
  249. <tr id="i9" class="rowColor">
  250. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
  251. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#toString--">toString</a></span>()</code>
  252. <div class="block">Gets a string describing the sensitivity.</div>
  253. </td>
  254. </tr>
  255. <tr id="i10" class="altColor">
  256. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a></code></td>
  257. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
  258. <div class="block">Returns the enum constant of this type with the specified name.</div>
  259. </td>
  260. </tr>
  261. <tr id="i11" class="rowColor">
  262. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a>[]</code></td>
  263. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/IOCase.html#values--">values</a></span>()</code>
  264. <div class="block">Returns an array containing the constants of this enum type, in
  265. the order they are declared.</div>
  266. </td>
  267. </tr>
  268. </table>
  269. <ul class="blockList">
  270. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
  271. <!-- -->
  272. </a>
  273. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
  274. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
  275. </ul>
  276. <ul class="blockList">
  277. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  278. <!-- -->
  279. </a>
  280. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
  281. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
  282. </ul>
  283. </li>
  284. </ul>
  285. </li>
  286. </ul>
  287. </div>
  288. <div class="details">
  289. <ul class="blockList">
  290. <li class="blockList">
  291. <!-- ============ ENUM CONSTANT DETAIL =========== -->
  292. <ul class="blockList">
  293. <li class="blockList"><a name="enum.constant.detail">
  294. <!-- -->
  295. </a>
  296. <h3>Enum Constant Detail</h3>
  297. <a name="SENSITIVE">
  298. <!-- -->
  299. </a>
  300. <ul class="blockList">
  301. <li class="blockList">
  302. <h4>SENSITIVE</h4>
  303. <pre>public static final&nbsp;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> SENSITIVE</pre>
  304. <div class="block">The constant for case sensitive regardless of operating system.</div>
  305. </li>
  306. </ul>
  307. <a name="INSENSITIVE">
  308. <!-- -->
  309. </a>
  310. <ul class="blockList">
  311. <li class="blockList">
  312. <h4>INSENSITIVE</h4>
  313. <pre>public static final&nbsp;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> INSENSITIVE</pre>
  314. <div class="block">The constant for case insensitive regardless of operating system.</div>
  315. </li>
  316. </ul>
  317. <a name="SYSTEM">
  318. <!-- -->
  319. </a>
  320. <ul class="blockListLast">
  321. <li class="blockList">
  322. <h4>SYSTEM</h4>
  323. <pre>public static final&nbsp;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a> SYSTEM</pre>
  324. <div class="block">The constant for case sensitivity determined by the current operating system.
  325. Windows is case-insensitive when comparing filenames, Unix is case-sensitive.
  326. <p>
  327. <strong>Note:</strong> This only caters for Windows and Unix. Other operating
  328. systems (e.g. OSX and OpenVMS) are treated as case sensitive if they use the
  329. Unix file separator and case-insensitive if they use the Windows file separator
  330. (see <a href="http://docs.oracle.com/javase/7/docs/api/java/io/File.html?is-external=true#separatorChar" title="class or interface in java.io"><code>File.separatorChar</code></a>).
  331. <p>
  332. If you serialize this constant on Windows, and deserialize on Unix, or vice
  333. versa, then the value of the case-sensitivity flag will change.</div>
  334. </li>
  335. </ul>
  336. </li>
  337. </ul>
  338. <!-- ============ METHOD DETAIL ========== -->
  339. <ul class="blockList">
  340. <li class="blockList"><a name="method.detail">
  341. <!-- -->
  342. </a>
  343. <h3>Method Detail</h3>
  344. <a name="values--">
  345. <!-- -->
  346. </a>
  347. <ul class="blockList">
  348. <li class="blockList">
  349. <h4>values</h4>
  350. <pre>public static&nbsp;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a>[]&nbsp;values()</pre>
  351. <div class="block">Returns an array containing the constants of this enum type, in
  352. the order they are declared. This method may be used to iterate
  353. over the constants as follows:
  354. <pre>
  355. for (IOCase c : IOCase.values())
  356. &nbsp; System.out.println(c);
  357. </pre></div>
  358. <dl>
  359. <dt><span class="returnLabel">Returns:</span></dt>
  360. <dd>an array containing the constants of this enum type, in the order they are declared</dd>
  361. </dl>
  362. </li>
  363. </ul>
  364. <a name="valueOf-java.lang.String-">
  365. <!-- -->
  366. </a>
  367. <ul class="blockList">
  368. <li class="blockList">
  369. <h4>valueOf</h4>
  370. <pre>public static&nbsp;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a>&nbsp;valueOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
  371. <div class="block">Returns the enum constant of this type with the specified name.
  372. The string must match <i>exactly</i> an identifier used to declare an
  373. enum constant in this type. (Extraneous whitespace characters are
  374. not permitted.)</div>
  375. <dl>
  376. <dt><span class="paramLabel">Parameters:</span></dt>
  377. <dd><code>name</code> - the name of the enum constant to be returned.</dd>
  378. <dt><span class="returnLabel">Returns:</span></dt>
  379. <dd>the enum constant with the specified name</dd>
  380. <dt><span class="throwsLabel">Throws:</span></dt>
  381. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
  382. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
  383. </dl>
  384. </li>
  385. </ul>
  386. <a name="forName-java.lang.String-">
  387. <!-- -->
  388. </a>
  389. <ul class="blockList">
  390. <li class="blockList">
  391. <h4>forName</h4>
  392. <pre>public static&nbsp;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a>&nbsp;forName(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
  393. <div class="block">Factory method to create an IOCase from a name.</div>
  394. <dl>
  395. <dt><span class="paramLabel">Parameters:</span></dt>
  396. <dd><code>name</code> - the name to find</dd>
  397. <dt><span class="returnLabel">Returns:</span></dt>
  398. <dd>the IOCase object</dd>
  399. <dt><span class="throwsLabel">Throws:</span></dt>
  400. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the name is invalid</dd>
  401. </dl>
  402. </li>
  403. </ul>
  404. <a name="getName--">
  405. <!-- -->
  406. </a>
  407. <ul class="blockList">
  408. <li class="blockList">
  409. <h4>getName</h4>
  410. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getName()</pre>
  411. <div class="block">Gets the name of the constant.</div>
  412. <dl>
  413. <dt><span class="returnLabel">Returns:</span></dt>
  414. <dd>the name of the constant</dd>
  415. </dl>
  416. </li>
  417. </ul>
  418. <a name="isCaseSensitive--">
  419. <!-- -->
  420. </a>
  421. <ul class="blockList">
  422. <li class="blockList">
  423. <h4>isCaseSensitive</h4>
  424. <pre>public&nbsp;boolean&nbsp;isCaseSensitive()</pre>
  425. <div class="block">Does the object represent case sensitive comparison.</div>
  426. <dl>
  427. <dt><span class="returnLabel">Returns:</span></dt>
  428. <dd>true if case sensitive</dd>
  429. </dl>
  430. </li>
  431. </ul>
  432. <a name="checkCompareTo-java.lang.String-java.lang.String-">
  433. <!-- -->
  434. </a>
  435. <ul class="blockList">
  436. <li class="blockList">
  437. <h4>checkCompareTo</h4>
  438. <pre>public&nbsp;int&nbsp;checkCompareTo(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str1,
  439. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str2)</pre>
  440. <div class="block">Compares two strings using the case-sensitivity rule.
  441. <p>
  442. This method mimics <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true#compareTo-java.lang.String-" title="class or interface in java.lang"><code>String.compareTo(java.lang.String)</code></a> but takes case-sensitivity
  443. into account.</div>
  444. <dl>
  445. <dt><span class="paramLabel">Parameters:</span></dt>
  446. <dd><code>str1</code> - the first string to compare, not null</dd>
  447. <dd><code>str2</code> - the second string to compare, not null</dd>
  448. <dt><span class="returnLabel">Returns:</span></dt>
  449. <dd>true if equal using the case rules</dd>
  450. <dt><span class="throwsLabel">Throws:</span></dt>
  451. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if either string is null</dd>
  452. </dl>
  453. </li>
  454. </ul>
  455. <a name="checkEquals-java.lang.String-java.lang.String-">
  456. <!-- -->
  457. </a>
  458. <ul class="blockList">
  459. <li class="blockList">
  460. <h4>checkEquals</h4>
  461. <pre>public&nbsp;boolean&nbsp;checkEquals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str1,
  462. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str2)</pre>
  463. <div class="block">Compares two strings using the case-sensitivity rule.
  464. <p>
  465. This method mimics <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang"><code>String.equals(java.lang.Object)</code></a> but takes case-sensitivity
  466. into account.</div>
  467. <dl>
  468. <dt><span class="paramLabel">Parameters:</span></dt>
  469. <dd><code>str1</code> - the first string to compare, not null</dd>
  470. <dd><code>str2</code> - the second string to compare, not null</dd>
  471. <dt><span class="returnLabel">Returns:</span></dt>
  472. <dd>true if equal using the case rules</dd>
  473. <dt><span class="throwsLabel">Throws:</span></dt>
  474. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if either string is null</dd>
  475. </dl>
  476. </li>
  477. </ul>
  478. <a name="checkStartsWith-java.lang.String-java.lang.String-">
  479. <!-- -->
  480. </a>
  481. <ul class="blockList">
  482. <li class="blockList">
  483. <h4>checkStartsWith</h4>
  484. <pre>public&nbsp;boolean&nbsp;checkStartsWith(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str,
  485. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;start)</pre>
  486. <div class="block">Checks if one string starts with another using the case-sensitivity rule.
  487. <p>
  488. This method mimics <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true#startsWith-java.lang.String-" title="class or interface in java.lang"><code>String.startsWith(String)</code></a> but takes case-sensitivity
  489. into account.</div>
  490. <dl>
  491. <dt><span class="paramLabel">Parameters:</span></dt>
  492. <dd><code>str</code> - the string to check, not null</dd>
  493. <dd><code>start</code> - the start to compare against, not null</dd>
  494. <dt><span class="returnLabel">Returns:</span></dt>
  495. <dd>true if equal using the case rules</dd>
  496. <dt><span class="throwsLabel">Throws:</span></dt>
  497. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if either string is null</dd>
  498. </dl>
  499. </li>
  500. </ul>
  501. <a name="checkEndsWith-java.lang.String-java.lang.String-">
  502. <!-- -->
  503. </a>
  504. <ul class="blockList">
  505. <li class="blockList">
  506. <h4>checkEndsWith</h4>
  507. <pre>public&nbsp;boolean&nbsp;checkEndsWith(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str,
  508. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;end)</pre>
  509. <div class="block">Checks if one string ends with another using the case-sensitivity rule.
  510. <p>
  511. This method mimics <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true#endsWith-java.lang.String-" title="class or interface in java.lang"><code>String.endsWith(java.lang.String)</code></a> but takes case-sensitivity
  512. into account.</div>
  513. <dl>
  514. <dt><span class="paramLabel">Parameters:</span></dt>
  515. <dd><code>str</code> - the string to check, not null</dd>
  516. <dd><code>end</code> - the end to compare against, not null</dd>
  517. <dt><span class="returnLabel">Returns:</span></dt>
  518. <dd>true if equal using the case rules</dd>
  519. <dt><span class="throwsLabel">Throws:</span></dt>
  520. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if either string is null</dd>
  521. </dl>
  522. </li>
  523. </ul>
  524. <a name="checkIndexOf-java.lang.String-int-java.lang.String-">
  525. <!-- -->
  526. </a>
  527. <ul class="blockList">
  528. <li class="blockList">
  529. <h4>checkIndexOf</h4>
  530. <pre>public&nbsp;int&nbsp;checkIndexOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str,
  531. int&nbsp;strStartIndex,
  532. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;search)</pre>
  533. <div class="block">Checks if one string contains another starting at a specific index using the
  534. case-sensitivity rule.
  535. <p>
  536. This method mimics parts of <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true#indexOf-java.lang.String-int-" title="class or interface in java.lang"><code>String.indexOf(String, int)</code></a>
  537. but takes case-sensitivity into account.</div>
  538. <dl>
  539. <dt><span class="paramLabel">Parameters:</span></dt>
  540. <dd><code>str</code> - the string to check, not null</dd>
  541. <dd><code>strStartIndex</code> - the index to start at in str</dd>
  542. <dd><code>search</code> - the start to search for, not null</dd>
  543. <dt><span class="returnLabel">Returns:</span></dt>
  544. <dd>the first index of the search String,
  545. -1 if no match or <code>null</code> string input</dd>
  546. <dt><span class="throwsLabel">Throws:</span></dt>
  547. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if either string is null</dd>
  548. <dt><span class="simpleTagLabel">Since:</span></dt>
  549. <dd>2.0</dd>
  550. </dl>
  551. </li>
  552. </ul>
  553. <a name="checkRegionMatches-java.lang.String-int-java.lang.String-">
  554. <!-- -->
  555. </a>
  556. <ul class="blockList">
  557. <li class="blockList">
  558. <h4>checkRegionMatches</h4>
  559. <pre>public&nbsp;boolean&nbsp;checkRegionMatches(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;str,
  560. int&nbsp;strStartIndex,
  561. <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;search)</pre>
  562. <div class="block">Checks if one string contains another at a specific index using the case-sensitivity rule.
  563. <p>
  564. This method mimics parts of <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true#regionMatches-boolean-int-java.lang.String-int-int-" title="class or interface in java.lang"><code>String.regionMatches(boolean, int, String, int, int)</code></a>
  565. but takes case-sensitivity into account.</div>
  566. <dl>
  567. <dt><span class="paramLabel">Parameters:</span></dt>
  568. <dd><code>str</code> - the string to check, not null</dd>
  569. <dd><code>strStartIndex</code> - the index to start at in str</dd>
  570. <dd><code>search</code> - the start to search for, not null</dd>
  571. <dt><span class="returnLabel">Returns:</span></dt>
  572. <dd>true if equal using the case rules</dd>
  573. <dt><span class="throwsLabel">Throws:</span></dt>
  574. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if either string is null</dd>
  575. </dl>
  576. </li>
  577. </ul>
  578. <a name="toString--">
  579. <!-- -->
  580. </a>
  581. <ul class="blockListLast">
  582. <li class="blockList">
  583. <h4>toString</h4>
  584. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
  585. <div class="block">Gets a string describing the sensitivity.</div>
  586. <dl>
  587. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  588. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../org/apache/commons/io/IOCase.html" title="enum in org.apache.commons.io">IOCase</a>&gt;</code></dd>
  589. <dt><span class="returnLabel">Returns:</span></dt>
  590. <dd>a string describing the sensitivity</dd>
  591. </dl>
  592. </li>
  593. </ul>
  594. </li>
  595. </ul>
  596. </li>
  597. </ul>
  598. </div>
  599. </div>
  600. <!-- ========= END OF CLASS DATA ========= -->
  601. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  602. <div class="bottomNav"><a name="navbar.bottom">
  603. <!-- -->
  604. </a>
  605. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  606. <a name="navbar.bottom.firstrow">
  607. <!-- -->
  608. </a>
  609. <ul class="navList" title="Navigation">
  610. <li><a href="../../../../overview-summary.html">Overview</a></li>
  611. <li><a href="package-summary.html">Package</a></li>
  612. <li class="navBarCell1Rev">Class</li>
  613. <li><a href="class-use/IOCase.html">Use</a></li>
  614. <li><a href="package-tree.html">Tree</a></li>
  615. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  616. <li><a href="../../../../index-all.html">Index</a></li>
  617. <li><a href="../../../../help-doc.html">Help</a></li>
  618. </ul>
  619. </div>
  620. <div class="subNav">
  621. <ul class="navList">
  622. <li><a href="../../../../org/apache/commons/io/HexDump.html" title="class in org.apache.commons.io"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  623. <li><a href="../../../../org/apache/commons/io/IOExceptionWithCause.html" title="class in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  624. </ul>
  625. <ul class="navList">
  626. <li><a href="../../../../index.html?org/apache/commons/io/IOCase.html" target="_top">Frames</a></li>
  627. <li><a href="IOCase.html" target="_top">No&nbsp;Frames</a></li>
  628. </ul>
  629. <ul class="navList" id="allclasses_navbar_bottom">
  630. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  631. </ul>
  632. <div>
  633. <script type="text/javascript"><!--
  634. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  635. if(window==top) {
  636. allClassesLink.style.display = "block";
  637. }
  638. else {
  639. allClassesLink.style.display = "none";
  640. }
  641. //-->
  642. </script>
  643. </div>
  644. <div>
  645. <ul class="subNavList">
  646. <li>Summary:&nbsp;</li>
  647. <li>Nested&nbsp;|&nbsp;</li>
  648. <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
  649. <li>Field&nbsp;|&nbsp;</li>
  650. <li><a href="#method.summary">Method</a></li>
  651. </ul>
  652. <ul class="subNavList">
  653. <li>Detail:&nbsp;</li>
  654. <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
  655. <li>Field&nbsp;|&nbsp;</li>
  656. <li><a href="#method.detail">Method</a></li>
  657. </ul>
  658. </div>
  659. <a name="skip.navbar.bottom">
  660. <!-- -->
  661. </a></div>
  662. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  663. <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
  664. </body>
  665. </html>