|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.io.IOCase
public final class IOCase
Enumeration of IO case sensitivity.
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.
Field Summary | |
---|---|
static IOCase |
INSENSITIVE
The constant for case insensitive regardless of operating system. |
static IOCase |
SENSITIVE
The constant for case sensitive regardless of operating system. |
static IOCase |
SYSTEM
The constant for case sensitivity determined by the current operating system. |
Method Summary | |
---|---|
int |
checkCompareTo(String str1,
String str2)
Compares two strings using the case-sensitivity rule. |
boolean |
checkEndsWith(String str,
String end)
Checks if one string ends with another using the case-sensitivity rule. |
boolean |
checkEquals(String str1,
String str2)
Compares two strings using the case-sensitivity rule. |
boolean |
checkRegionMatches(String str,
int strStartIndex,
String search)
Checks if one string contains another at a specific index using the case-sensitivity rule. |
boolean |
checkStartsWith(String str,
String start)
Checks if one string starts with another using the case-sensitivity rule. |
static IOCase |
forName(String name)
Factory method to create an IOCase from a name. |
String |
getName()
Gets the name of the constant. |
boolean |
isCaseSensitive()
Does the object represent case sensitive comparison. |
String |
toString()
Gets a string describing the sensitivity. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final IOCase SENSITIVE
public static final IOCase INSENSITIVE
public static final IOCase SYSTEM
If you derialize this constant of Windows, and deserialize on Unix, or vice versa, then the value of the case-sensitivity flag will change.
Method Detail |
---|
public static IOCase forName(String name)
name
- the name to find
IllegalArgumentException
- if the name is invalidpublic String getName()
public boolean isCaseSensitive()
public int checkCompareTo(String str1, 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 null
NullPointerException
- if either string is nullpublic boolean checkEquals(String str1, 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 null
NullPointerException
- if either string is nullpublic boolean checkStartsWith(String str, 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 null
NullPointerException
- if either string is nullpublic boolean checkEndsWith(String str, 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 null
NullPointerException
- if either string is nullpublic boolean checkRegionMatches(String str, int strStartIndex, 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 null
NullPointerException
- if either string is nullpublic String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |