de.unkrig.commons.lang

Class StringUtil.AbstractIndexOf

java.lang.Object

de.unkrig.commons.lang.StringUtil.AbstractIndexOf

All Implemented Interfaces:

StringUtil.IndexOf

Enclosing class:

StringUtil

public abstract static class StringUtil.AbstractIndexOf
extends Object
implements StringUtil.IndexOf

Constructor Summary

Constructors

Constructor and Description
AbstractIndexOf()

Method Summary

Modifier and Type	Method and Description
int	indexOf(CharSequence haystack) The equivalent of String.indexOf(String).
int	indexOf(CharSequence haystack, int minIndex) The equivalent of String.indexOf(String, int).
int	indexOf(CharSequence haystack, int minIndex, int maxIndex) Like StringUtil.IndexOf.indexOf(CharSequence, int), but the match terminates at index maxIndex (inclusive).
int	indexOf(CharSequence haystack, int minIndex, int maxIndex, int limit) Like StringUtil.IndexOf.indexOf(CharSequence, int, int), but never accesses haystack chars at position limit or greater.
int	lastIndexOf(CharSequence haystack) The equivalent of String.lastIndexOf(String).
int	lastIndexOf(CharSequence haystack, int maxIndex) The equivalent of String.lastIndexOf(String, int).
int	lastIndexOf(CharSequence haystack, int minIndex, int maxIndex) Like StringUtil.IndexOf.lastIndexOf(CharSequence, int), but the match terminates at index minIndex (inclusive).
abstract String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractIndexOf

public AbstractIndexOf()

Method Detail

indexOf

public int indexOf(CharSequence haystack)

Description copied from interface: StringUtil.IndexOf

The equivalent of String.indexOf(String).

For the return value, the following condition holds true:

   StringUtil.newIndexOf(needle).indexOf(haystack) == haystack.indexOf(needle)
 

Specified by:

indexOf in interface StringUtil.IndexOf

Returns:

0 ... haystack.length() - needle.length(), or -1

indexOf

public int indexOf(CharSequence haystack,
                   int minIndex)

Description copied from interface: StringUtil.IndexOf

The equivalent of String.indexOf(String, int).

For the return value, the following condition holds true:

   StringUtil.newIndexOf(needle).indexOf(haystack, minIndex) == haystack.indexOf(needle, minIndex)
 

Specified by:

indexOf in interface StringUtil.IndexOf

Returns:

max(0, minIndex) ... haystack.length() - needle.length(), or -1

lastIndexOf

public int lastIndexOf(CharSequence haystack)

Description copied from interface: StringUtil.IndexOf

The equivalent of String.lastIndexOf(String).

For the return value, the following condition holds true:

   StringUtil.newIndexOf(needle).lastIndexOf(haystack) == haystack.lastIndexOf(needle)
 

Specified by:

lastIndexOf in interface StringUtil.IndexOf

Returns:

0 ... haystack.length() - needle.length(), or -1

lastIndexOf

public int lastIndexOf(CharSequence haystack,
                       int maxIndex)

Description copied from interface: StringUtil.IndexOf

The equivalent of String.lastIndexOf(String, int).

For the return value, the following condition holds true:

   StringUtil.newIndexOf(needle).lastIndexOf(haystack, maxIndex) == haystack.lastIndexOf(needle, maxIndex)
 

Specified by:

lastIndexOf in interface StringUtil.IndexOf

Returns:

0 ... min(maxIndex, haystack.length() - needle.length()), or -1

indexOf

public int indexOf(CharSequence haystack,
                   int minIndex,
                   int maxIndex)

Description copied from interface: StringUtil.IndexOf

Like StringUtil.IndexOf.indexOf(CharSequence, int), but the match terminates at index maxIndex (inclusive).

Specified by:

indexOf in interface StringUtil.IndexOf

Returns:

max(0, minIndex) ... min(maxIndex, haystack.length() - needle.length()), or -1

indexOf

public int indexOf(CharSequence haystack,
                   int minIndex,
                   int maxIndex,
                   int limit)

Description copied from interface: StringUtil.IndexOf

Like StringUtil.IndexOf.indexOf(CharSequence, int, int), but never accesses haystack chars at position limit or greater. Instead, if there are partial matches at positions limit - needle.length - 1 ... limit - 1, then the first of these is returned.

Examples:

needle	haystack	minIndex	maxIndex	limit	result
ABCDE	_ABCDE_**	<=1	>=1	7	1
ABCDE	__ABCDE**	<=2	>=2	7	2
ABCDE	___ABCD**	<=3	>=3	7	3
ABCDE	____ABC**	<=4	>=4	7	4
ABCDE	_____AB**	<=5	>=5	7	5
ABCDE	______A**	<=6	>=6	7	6
ABCDE	_______**	<=7	>=7	7	7

("_": Any character but "ABCDE"; "*": Any character.)

Specified by:

indexOf in interface StringUtil.IndexOf

limit - 0...haystack.length

lastIndexOf

public int lastIndexOf(CharSequence haystack,
                       int minIndex,
                       int maxIndex)

Description copied from interface: StringUtil.IndexOf

Like StringUtil.IndexOf.lastIndexOf(CharSequence, int), but the match terminates at index minIndex (inclusive).

Specified by:

lastIndexOf in interface StringUtil.IndexOf

Returns:

max(0, minIndex) ... min(maxIndex, haystack.length() - needle.length()), or -1

toString

public abstract String toString()

Specified by:

toString in interface StringUtil.IndexOf

Overrides:

toString in class Object

Returns:

A textual representation of the needle and the search algorithm