org.apache.commons.lang3

Class CharSequenceUtils

java.lang.Object

org.apache.commons.lang3.CharSequenceUtils

public class CharSequenceUtils
extends java.lang.Object

Operations on CharSequence that are null safe.

Since:

3.0

See Also:

CharSequence

Field Summary

Fields

Modifier and Type	Field and Description
private static int	NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
CharSequenceUtils() CharSequenceUtils instances should NOT be constructed in standard programming.

Method Summary

Modifier and Type	Method and Description
(package private) static int	indexOf(java.lang.CharSequence cs, java.lang.CharSequence searchChar, int start) Used by the indexOf(CharSequence methods) as a green implementation of indexOf.
(package private) static int	indexOf(java.lang.CharSequence cs, int searchChar, int start) Finds the first index in the CharSequence that matches the specified character.
(package private) static int	lastIndexOf(java.lang.CharSequence cs, java.lang.CharSequence searchChar, int start) Used by the lastIndexOf(CharSequence methods) as a green implementation of lastIndexOf
(package private) static int	lastIndexOf(java.lang.CharSequence cs, int searchChar, int start) Finds the last index in the CharSequence that matches the specified character.
(package private) static boolean	regionMatches(java.lang.CharSequence cs, boolean ignoreCase, int thisStart, java.lang.CharSequence substring, int start, int length) Green implementation of regionMatches.
static java.lang.CharSequence	subSequence(java.lang.CharSequence cs, int start) Returns a new CharSequence that is a subsequence of this sequence starting with the char value at the specified index.
(package private) static char[]	toCharArray(java.lang.CharSequence cs) Green implementation of toCharArray.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NOT_FOUND

private static final int NOT_FOUND

See Also:

Constant Field Values

Constructor Detail

CharSequenceUtils

public CharSequenceUtils()

CharSequenceUtils instances should NOT be constructed in standard programming.

This constructor is public to permit tools that require a JavaBean instance to operate.

Method Detail

subSequence

public static java.lang.CharSequence subSequence(java.lang.CharSequence cs,
                                                 int start)

Returns a new CharSequence that is a subsequence of this sequence starting with the char value at the specified index.

This provides the CharSequence equivalent to String.substring(int). The length (in char) of the returned sequence is length() - start, so if start == end then an empty sequence is returned.

Parameters:

cs - the specified subsequence, null returns null

start - the start index, inclusive, valid

Returns:

a new subsequence, may be null

Throws:

java.lang.IndexOutOfBoundsException - if start is negative or if start is greater than length()

indexOf

static int indexOf(java.lang.CharSequence cs,
                   int searchChar,
                   int start)

Finds the first index in the CharSequence that matches the specified character.

Parameters:

cs - the CharSequence to be processed, not null

searchChar - the char to be searched for

start - the start index, negative starts at the string start

Returns:

the index where the search char was found, -1 if not found

indexOf

static int indexOf(java.lang.CharSequence cs,
                   java.lang.CharSequence searchChar,
                   int start)

Used by the indexOf(CharSequence methods) as a green implementation of indexOf.

Parameters:

cs - the CharSequence to be processed

searchChar - the CharSequence to be searched for

start - the start index

Returns:

the index where the search sequence was found

lastIndexOf

static int lastIndexOf(java.lang.CharSequence cs,
                       int searchChar,
                       int start)

Finds the last index in the CharSequence that matches the specified character.

Parameters:

cs - the CharSequence to be processed

searchChar - the char to be searched for

start - the start index, negative returns -1, beyond length starts at end

Returns:

the index where the search char was found, -1 if not found

lastIndexOf

static int lastIndexOf(java.lang.CharSequence cs,
                       java.lang.CharSequence searchChar,
                       int start)

Used by the lastIndexOf(CharSequence methods) as a green implementation of lastIndexOf

Parameters:

cs - the CharSequence to be processed

searchChar - the CharSequence to be searched for

start - the start index

Returns:

the index where the search sequence was found

toCharArray

static char[] toCharArray(java.lang.CharSequence cs)

Green implementation of toCharArray.

Parameters:

cs - the CharSequence to be processed

Returns:

the resulting char array

regionMatches

static boolean regionMatches(java.lang.CharSequence cs,
                             boolean ignoreCase,
                             int thisStart,
                             java.lang.CharSequence substring,
                             int start,
                             int length)

Green implementation of regionMatches.

Parameters:

cs - the CharSequence to be processed

ignoreCase - whether or not to be case insensitive

thisStart - the index to start on the cs CharSequence

substring - the CharSequence to be looked for

start - the index to start on the substring CharSequence

length - character length of the region

Returns:

whether the region matched