org.osgl.util.algo

Class StringSearch

java.lang.Object

org.osgl.util.algo.StringSearch

All Implemented Interfaces:

Lang.Func3<char[],char[],Integer,Integer>

Direct Known Subclasses:

StringSearch.SimpleStringSearch

public abstract class StringSearch
extends Object
implements Lang.Func3<char[],char[],Integer,Integer>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StringSearch.SimpleStringSearch Implement a simple string search algorithm using JDK String.indexOf algorithm

Constructor Summary

Constructors

Constructor and Description
StringSearch()

Method Summary

Modifier and Type	Method and Description
Integer	apply(char[] text, char[] target, Integer from) Run the function with parameters specified.
abstract int	search(char[] text, char[] target, int from) Search a char array in another char array with from index specified
static StringSearch	wrap(Lang.Func3<char[],char[],Integer,Integer> searchLogic)

Methods inherited from class java.lang.Object

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

Constructor Detail

StringSearch

public StringSearch()

Method Detail

search

public abstract int search(char[] text,
                           char[] target,
                           int from)

Search a char array in another char array with from index specified

Parameters:

text - the char array to be searched

target - the pattern to be searched across the text

from - the from index it shall be non-negative number. If from index is negative number then it starts from 0; if from is greater than or equals to the text length then -1 will be returned

Returns:

index of the search pattern in the text. If the search pattern is found in the text region specified then it returns it’s index in the text; otherwise an negative number, typically -1 is returned

apply

public final Integer apply(char[] text,
                           char[] target,
                           Integer from)
                    throws NotAppliedException,
                           Lang.Break

Description copied from interface: Lang.Func3

Run the function with parameters specified.

In case implementing a partial function, it can throw out an NotAppliedException if the function is not defined for the given parameter(s)

Specified by:

apply in interface Lang.Func3<char[],char[],Integer,Integer>

Parameters:

text - argument 1

target - argument 2

from - argument 3

Returns:

the result of function applied

Throws:

NotAppliedException - if the function doesn’t apply to the parameter(s)

Lang.Break - to short cut collecting operations (fold/reduce) on an container

wrap

public static StringSearch wrap(Lang.Func3<char[],char[],Integer,Integer> searchLogic)