public enum IOCase extends java.lang.Enum<IOCase> implements java.io.Serializable
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 filename 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 filenames.
Enum Constant and Description |
---|
INSENSITIVE
The constant for case insensitive regardless of operating system.
|
SENSITIVE
The constant for case sensitive regardless of operating system.
|
SYSTEM
The constant for case sensitivity determined by the current operating system.
|
Modifier and Type | Method and Description |
---|---|
int |
checkCompareTo(java.lang.String str1,
java.lang.String str2)
Compares two strings using the case-sensitivity rule.
|
boolean |
checkEndsWith(java.lang.String str,
java.lang.String end)
Checks if one string ends with another using the case-sensitivity rule.
|
boolean |
checkEquals(java.lang.String str1,
java.lang.String str2)
Compares two strings using the case-sensitivity rule.
|
int |
checkIndexOf(java.lang.String str,
int strStartIndex,
java.lang.String search)
Checks if one string contains another starting at a specific index using the
case-sensitivity rule.
|
boolean |
checkRegionMatches(java.lang.String str,
int strStartIndex,
java.lang.String search)
Checks if one string contains another at a specific index using the case-sensitivity rule.
|
boolean |
checkStartsWith(java.lang.String str,
java.lang.String start)
Checks if one string starts with another using the case-sensitivity rule.
|
static IOCase |
forName(java.lang.String name)
Factory method to create an IOCase from a name.
|
java.lang.String |
getName()
Gets the name of the constant.
|
boolean |
isCaseSensitive()
Does the object represent case sensitive comparison.
|
java.lang.String |
toString()
Gets a string describing the sensitivity.
|
static IOCase |
valueOf(java.lang.String name)
Returns 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.
|
public static final IOCase SENSITIVE
public static final IOCase INSENSITIVE
public static final IOCase SYSTEM
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.
public static IOCase[] values()
for (IOCase c : IOCase.values()) System.out.println(c);
public static IOCase valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is nullpublic static IOCase forName(java.lang.String name)
name
- the name to findjava.lang.IllegalArgumentException
- if the name is invalidpublic java.lang.String getName()
public boolean isCaseSensitive()
public int checkCompareTo(java.lang.String str1, java.lang.String str2)
This method mimics String.compareTo(java.lang.String)
but takes case-sensitivity
into account.
str1
- the first string to compare, not nullstr2
- the second string to compare, not nulljava.lang.NullPointerException
- if either string is nullpublic boolean checkEquals(java.lang.String str1, java.lang.String str2)
This method mimics String.equals(java.lang.Object)
but takes case-sensitivity
into account.
str1
- the first string to compare, not nullstr2
- the second string to compare, not nulljava.lang.NullPointerException
- if either string is nullpublic boolean checkStartsWith(java.lang.String str, java.lang.String start)
This method mimics String.startsWith(String)
but takes case-sensitivity
into account.
str
- the string to check, not nullstart
- the start to compare against, not nulljava.lang.NullPointerException
- if either string is nullpublic boolean checkEndsWith(java.lang.String str, java.lang.String end)
This method mimics String.endsWith(java.lang.String)
but takes case-sensitivity
into account.
str
- the string to check, not nullend
- the end to compare against, not nulljava.lang.NullPointerException
- if either string is nullpublic int checkIndexOf(java.lang.String str, int strStartIndex, java.lang.String search)
This method mimics parts of String.indexOf(String, int)
but takes case-sensitivity into account.
str
- the string to check, not nullstrStartIndex
- the index to start at in strsearch
- the start to search for, not nullnull
string inputjava.lang.NullPointerException
- if either string is nullpublic boolean checkRegionMatches(java.lang.String str, int strStartIndex, java.lang.String search)
This method mimics parts of String.regionMatches(boolean, int, String, int, int)
but takes case-sensitivity into account.
str
- the string to check, not nullstrStartIndex
- the index to start at in strsearch
- the start to search for, not nulljava.lang.NullPointerException
- if either string is nullpublic java.lang.String toString()
toString
in class java.lang.Enum<IOCase>
Copyright © 2010 - 2020 Adobe. All Rights Reserved