Enum IOCase
- All Implemented Interfaces:
- Serializable,- Comparable<IOCase>
Different filing systems have different rules for case-sensitivity. Windows is case-insensitive, Unix is case-sensitive.
This class captures that difference, providing an enumeration to control how file name comparisons should be performed. It also provides methods that use the enumeration to perform comparisons.
 Wherever possible, you should use the check methods in this
 class to compare file names.
 
- Since:
- 1.3
- 
Enum Constant SummaryEnum ConstantsEnum ConstantDescriptionThe constant for case-insensitive regardless of operating system.The constant for case-sensitive regardless of operating system.The constant for case sensitivity determined by the current operating system.
- 
Method SummaryModifier and TypeMethodDescriptionintcheckCompareTo(String str1, String str2) Compares two strings using the case-sensitivity rule.booleancheckEndsWith(String str, String end) Checks if one string ends with another using the case-sensitivity rule.booleancheckEquals(String str1, String str2) Compares two strings using the case-sensitivity rule.intcheckIndexOf(String str, int strStartIndex, String search) Checks if one string contains another starting at a specific index using the case-sensitivity rule.booleancheckRegionMatches(String str, int strStartIndex, String search) Checks if one string contains another at a specific index using the case-sensitivity rule.booleancheckStartsWith(String str, String start) Checks if one string starts with another using the case-sensitivity rule.static IOCaseLooks up an IOCase by name.getName()Gets the name of the constant.booleanDoes the object represent case-sensitive comparison.static booleanisCaseSensitive(IOCase ioCase) Tests for cases sensitivity in a null-safe manner.toString()Gets a string describing the sensitivity.static IOCaseReturns the given value if not-null, the defaultValue if null.static IOCaseReturns the enum constant of this type with the specified name.static IOCase[]values()Returns an array containing the constants of this enum type, in the order they are declared.
- 
Enum Constant Details- 
SENSITIVEThe constant for case-sensitive regardless of operating system.
- 
INSENSITIVEThe constant for case-insensitive regardless of operating system.
- 
SYSTEMThe constant for case sensitivity determined by the current operating system. Windows is case-insensitive when comparing file names, Unix is case-sensitive.Note: This only caters for Windows and Unix. Other operating systems (e.g. OSX and OpenVMS) are treated as case-sensitive if they use the Unix file separator and case-insensitive if they use the Windows file separator (see File.separatorChar).If you serialize this constant on Windows, and deserialize on Unix, or vice versa, then the value of the case-sensitivity flag will change. 
 
- 
- 
Method Details- 
valuesReturns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
 
- 
valueOfReturns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
- name- the name of the enum constant to be returned.
- Returns:
- the enum constant with the specified name
- Throws:
- IllegalArgumentException- if this enum type has no constant with the specified name
- NullPointerException- if the argument is null
 
- 
forNameLooks up an IOCase by name.- Parameters:
- name- the name to find
- Returns:
- the IOCase object
- Throws:
- IllegalArgumentException- if the name is invalid
 
- 
isCaseSensitiveTests for cases sensitivity in a null-safe manner.- Parameters:
- ioCase- an IOCase.
- Returns:
- true if the input is non-null and isCaseSensitive().
- Since:
- 2.10.0
 
- 
valueReturns the given value if not-null, the defaultValue if null.- Parameters:
- value- the value to test.
- defaultValue- the default value.
- Returns:
- the given value if not-null, the defaultValue if null.
- Since:
- 2.12.0
 
- 
checkCompareToCompares two strings using the case-sensitivity rule.This method mimics String.compareTo(java.lang.String)but takes case-sensitivity into account.- Parameters:
- str1- the first string to compare, not null.
- str2- the second string to compare, not null.
- Returns:
- true if equal using the case rules.
- Throws:
- NullPointerException- if either string is null.
 
- 
checkEndsWithChecks if one string ends with another using the case-sensitivity rule.This method mimics String.endsWith(java.lang.String)but takes case-sensitivity into account.- Parameters:
- str- the string to check.
- end- the end to compare against.
- Returns:
- true if equal using the case rules, false if either input is null.
 
- 
checkEqualsCompares two strings using the case-sensitivity rule.This method mimics String.equals(java.lang.Object)but takes case-sensitivity into account.- Parameters:
- str1- the first string to compare.
- str2- the second string to compare.
- Returns:
- true if equal using the case rules.
 
- 
checkIndexOfChecks if one string contains another starting at a specific index using the case-sensitivity rule.This method mimics parts of String.indexOf(String, int)but takes case-sensitivity into account.- Parameters:
- str- the string to check.
- strStartIndex- the index to start at in str.
- search- the start to search for.
- Returns:
- the first index of the search String,
  -1 if no match or nullstring input.
- Since:
- 2.0
 
- 
checkRegionMatchesChecks if one string contains another at a specific index using the case-sensitivity rule.This method mimics parts of String.regionMatches(boolean, int, String, int, int)but takes case-sensitivity into account.- Parameters:
- str- the string to check.
- strStartIndex- the index to start at in str.
- search- the start to search for,.
- Returns:
- true if equal using the case rules.
 
- 
checkStartsWithChecks if one string starts with another using the case-sensitivity rule.This method mimics String.startsWith(String)but takes case-sensitivity into account.- Parameters:
- str- the string to check.
- start- the start to compare against.
- Returns:
- true if equal using the case rules, false if either input is null.
 
- 
getNameGets the name of the constant.- Returns:
- the name of the constant
 
- 
isCaseSensitiveDoes the object represent case-sensitive comparison.- Returns:
- true if case-sensitive.
 
- 
toStringGets a string describing the sensitivity.
 
-