org.apache.commons.io
Class IOCase

java.lang.Object
  extended by org.apache.commons.io.IOCase
All Implemented Interfaces:
Serializable

public final class IOCase
extends Object
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.

Since:
Commons IO 1.3
Version:
$Id: IOCase.java 484844 2006-12-08 23:27:18Z ggregory $
Author:
Stephen Colebourne
See Also:
Serialized Form

Field Summary
static IOCase INSENSITIVE
          The constant for case insensitive regardless of operating system.
private  String name
          The enumeration name.
private  boolean sensitive
          The sensitivity flag.
static IOCase SENSITIVE
          The constant for case sensitive regardless of operating system.
private static long serialVersionUID
          Serialization version.
static IOCase SYSTEM
          The constant for case sensitivity determined by the current operating system.
 
Constructor Summary
private IOCase(String name, boolean sensitive)
          Private constructor.
 
Method Summary
 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.
(package private)  String convertCase(String str)
          Converts the case of the input String to a standard format.
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.
private  Object readResolve()
          Replaces the enumeration from the stream with a real one.
 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

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.

If you derialize this constant of Windows, and deserialize on Unix, or vice versa, then the value of the case-sensitivity flag will change.


serialVersionUID

private static final long serialVersionUID
Serialization version.

See Also:
Constant Field Values

name

private final String name
The enumeration name.


sensitive

private final transient boolean sensitive
The sensitivity flag.

Constructor Detail

IOCase

private IOCase(String name,
               boolean sensitive)
Private constructor.

Parameters:
name - the name
sensitive - the sensitivity
Method Detail

forName

public static IOCase forName(String name)
Factory method to create an IOCase from a name.

Parameters:
name - the name to find
Returns:
the IOCase object
Throws:
IllegalArgumentException - if the name is invalid

readResolve

private Object readResolve()
Replaces the enumeration from the stream with a real one. This ensures that the correct flag is set for SYSTEM.

Returns:
the resolved object

getName

public String getName()
Gets the name of the constant.

Returns:
the name of the constant

isCaseSensitive

public boolean isCaseSensitive()
Does the object represent case sensitive comparison.

Returns:
true if case sensitive

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.

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

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.

Parameters:
str - the string to check, not null
start - the start to compare against, not null
Returns:
true if equal using the case rules
Throws:
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.

Parameters:
str - the string to check, not null
end - the end to compare against, not null
Returns:
true if equal using the case rules
Throws:
NullPointerException - if either string is null

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.

Parameters:
str - the string to check, not null
strStartIndex - the index to start at in str
search - the start to search for, not null
Returns:
true if equal using the case rules
Throws:
NullPointerException - if either string is null

convertCase

String convertCase(String str)
Converts the case of the input String to a standard format. Subsequent operations can then use standard String methods.

Parameters:
str - the string to convert, null returns null
Returns:
the lower-case version if case-insensitive

toString

public String toString()
Gets a string describing the sensitivity.

Overrides:
toString in class Object
Returns:
a string describing the sensitivity