IOCase (CommonsIO API)

java.lang.Object
- java.lang.Enum<IOCase>
- - org.apache.commons.io.IOCase

所有已实现的接口:

Serializable, Comparable<IOCase>
```
public enum IOCase
extends Enum<IOCase>
implements Serializable
```
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.

从以下版本开始:

1.3

枚举常量概要

枚举常量
枚举常量和说明
`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.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`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.
`int`	`checkIndexOf(String str, int strStartIndex, String search)` Checks if one string contains another starting at a specific index 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.
`static IOCase`	`valueOf(String name)` 返回带有指定名称的该类型的枚举常量。
`static IOCase[]`	`values()` 按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。

从类继承的方法 java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

从类继承的方法 java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 枚举常量详细资料
  - SENSITIVE
```
public static final IOCase SENSITIVE
```
    The constant for case sensitive regardless of operating system.
  - INSENSITIVE
```
public static final IOCase INSENSITIVE
```
    The constant for case insensitive regardless of operating system.
  - SYSTEM
```
public static final IOCase SYSTEM
```
    The constant for case sensitivity determined by the current operating system. Windows is case-insensitive when comparing filenames, 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 derialize this constant of Windows, and deserialize on Unix, or vice versa, then the value of the case-sensitivity flag will change.
- 方法详细资料
  - values
```
public static IOCase[] values()
```
    按照声明该枚举类型的常量的顺序, 返回包含这些常量的数组。该方法可用于迭代常量, 如下所示:
```
for (IOCase c : IOCase.values())
    System.out.println(c);
```
    返回:
    
    按照声明该枚举类型的常量的顺序返回的包含这些常量的数组
  - valueOf
```
public static IOCase valueOf(String name)
```
    返回带有指定名称的该类型的枚举常量。字符串必须与用于声明该类型的枚举常量的标识符完全匹配。(不允许有多余的空格字符。)
    
    参数:
    
    name - 要返回的枚举常量的名称。
    
    返回:
    
    返回带有指定名称的枚举常量
    
    抛出:
    
    IllegalArgumentException - 如果该枚举类型没有带有指定名称的常量
    
    NullPointerException - 如果参数为空值
  - forName
```
public static IOCase forName(String name)
```
    Factory method to create an IOCase from a name.
    
    参数:
    
    name - the name to find
    
    返回:
    
    the IOCase object
    
    抛出:
    
    IllegalArgumentException - if the name is invalid
  - getName
```
public String getName()
```
    Gets the name of the constant.
    
    返回:
    
    the name of the constant
  - isCaseSensitive
```
public boolean isCaseSensitive()
```
    Does the object represent case sensitive comparison.
    
    返回:
    
    true if case sensitive
  - checkCompareTo
```
public int checkCompareTo(String str1,
                          String str2)
```
    Compares two strings using the case-sensitivity rule.
    This method mimics String.compareTo(java.lang.String) but takes case-sensitivity into account.
    
    参数:
    
    str1 - the first string to compare, not null
    
    str2 - the second string to compare, not null
    
    返回:
    
    true if equal using the case rules
    
    抛出:
    
    NullPointerException - if either string is null
  - checkEquals
```
public boolean checkEquals(String str1,
                           String str2)
```
    Compares two strings using the case-sensitivity rule.
    This method mimics String.equals(java.lang.Object) but takes case-sensitivity into account.
    
    参数:
    
    str1 - the first string to compare, not null
    
    str2 - the second string to compare, not null
    
    返回:
    
    true if equal using the case rules
    
    抛出:
    
    NullPointerException - if either string is null
  - checkStartsWith
```
public boolean checkStartsWith(String str,
                               String start)
```
    Checks if one string starts with another using the case-sensitivity rule.
    This method mimics String.startsWith(String) but takes case-sensitivity into account.
    
    参数:
    
    str - the string to check, not null
    
    start - the start to compare against, not null
    
    返回:
    
    true if equal using the case rules
    
    抛出:
    
    NullPointerException - if either string is null
  - checkEndsWith
```
public boolean checkEndsWith(String str,
                             String end)
```
    Checks 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.
    
    参数:
    
    str - the string to check, not null
    
    end - the end to compare against, not null
    
    返回:
    
    true if equal using the case rules
    
    抛出:
    
    NullPointerException - if either string is null
  - checkIndexOf
```
public int checkIndexOf(String str,
                        int strStartIndex,
                        String search)
```
    Checks 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.
    
    参数:
    
    str - the string to check, not null
    
    strStartIndex - the index to start at in str
    
    search - the start to search for, not null
    
    返回:
    
    the first index of the search String, -1 if no match or null string input
    
    抛出:
    
    NullPointerException - if either string is null
    
    从以下版本开始:
    
    2.0
  - checkRegionMatches
```
public boolean checkRegionMatches(String str,
                                  int strStartIndex,
                                  String search)
```
    Checks 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.
    
    参数:
    
    str - the string to check, not null
    
    strStartIndex - the index to start at in str
    
    search - the start to search for, not null
    
    返回:
    
    true if equal using the case rules
    
    抛出:
    
    NullPointerException - if either string is null
  - toString
```
public String toString()
```
    Gets a string describing the sensitivity.
    
    覆盖:
    
    toString 在类中 Enum<IOCase>
    
    返回:
    
    a string describing the sensitivity

枚举 IOCase

枚举常量概要

方法概要

从类继承的方法 java.lang.Enum

从类继承的方法 java.lang.Object

枚举常量详细资料

SENSITIVE

INSENSITIVE

SYSTEM

方法详细资料

values

valueOf

forName

getName

isCaseSensitive

checkCompareTo

checkEquals

checkStartsWith

checkEndsWith

checkIndexOf

checkRegionMatches

toString