com.dkfqs.tools.text

Class SearchTextInLines

java.lang.Object

com.dkfqs.tools.text.SearchTextInLines

public class SearchTextInLines
extends java.lang.Object

Split a content into lines separated by '\n' chars and search a text within the lines.

See Also:

SearchTextInLinesResult

Constructor Summary

Constructors

Constructor and Description
SearchTextInLines(java.lang.String content) Create a new instance.

Method Summary

Modifier and Type	Method and Description
int	getLimitMaxResults() Get the limit of the maximum number of search results.
java.util.List<java.lang.String>	getLines() Get the lines of the content, splitted by '\n', without trailing '\r'.
boolean	isLimitMaxResultsReached() Get if the limit of max search results was reached.
java.util.List<SearchTextInLinesResult>	performSearch(java.lang.String text, boolean ignoreCase) Perform the search.
void	setLimitMaxResults(int limitMaxResults) Set the limit of the maximum number of search results (default = -1 = unlimited).

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTextInLines

public SearchTextInLines(java.lang.String content)

Create a new instance.

Parameters:

content - the content

Method Detail

getLimitMaxResults

public int getLimitMaxResults()

Get the limit of the maximum number of search results.

Returns:

the limit of the maximum number of search results, or -1 = unlimited

setLimitMaxResults

public void setLimitMaxResults(int limitMaxResults)

Set the limit of the maximum number of search results (default = -1 = unlimited).

Parameters:

limitMaxResults - the limit of the maximum number of search results, or -1 = unlimited

Throws:

java.lang.IllegalArgumentException - if the limit of the maximum number of search results is 0 (zero)

performSearch

public java.util.List<SearchTextInLinesResult> performSearch(java.lang.String text,
                                                             boolean ignoreCase)

Perform the search.

Parameters:

text - the text to search

ignoreCase - if true = ignore case

Returns:

a list of the search results

getLines

public java.util.List<java.lang.String> getLines()

Get the lines of the content, splitted by '\n', without trailing '\r'.

Returns:

the lines of the content, which can contain '\r' chars

isLimitMaxResultsReached

public boolean isLimitMaxResultsReached()

Get if the limit of max search results was reached.

Returns:

true = the limit of max search results was reached