com.dkfqs.tools.text

Class SearchTextInLinesResult

java.lang.Object

com.dkfqs.tools.text.SearchTextInLinesResult

All Implemented Interfaces:

java.lang.Comparable<SearchTextInLinesResult>

public class SearchTextInLinesResult
extends java.lang.Object
implements java.lang.Comparable<SearchTextInLinesResult>

A result of the SearchTextInLines class.

See Also:

SearchTextInLines

Constructor Summary

Constructors

Constructor and Description
SearchTextInLinesResult(java.lang.String foundText, int foundAtAbsoluteIndex, int foundAtLineNumber, int foundAtLineIndex, java.lang.String textFragmentBefore, java.lang.String textFragmentAfter) Create a new instance.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SearchTextInLinesResult otherInstance) Compare the absolute index of this instance with the absolute index of another instance.
void	dumpToStdout() Dump the content of this instance to stdout.
int	getFoundAtAbsoluteIndex() Get the absolute index (0..n-1).
int	getFoundAtLineIndex() Get the index within the line (0..n-1).
int	getFoundAtLineNumber() Get the line number (1..n).
java.lang.String	getFoundText() Get the text which was found.
java.lang.String	getTextFragmentAfter() Get the text fragment after the search text, or an empty string if no such data is available.
java.lang.String	getTextFragmentBefore() Get the text fragment before the search text, or an empty string if no such data is available.
JsonObject	toJsonObject() Get a JSON object of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchTextInLinesResult

public SearchTextInLinesResult(java.lang.String foundText,
                               int foundAtAbsoluteIndex,
                               int foundAtLineNumber,
                               int foundAtLineIndex,
                               java.lang.String textFragmentBefore,
                               java.lang.String textFragmentAfter)

Create a new instance.

Parameters:

foundText - foundText the text which was found

foundAtAbsoluteIndex - the absolute index (0..n-1)

foundAtLineNumber - the line number (1..n)

foundAtLineIndex - the index within the line (0..n-1)

textFragmentBefore - the text fragment before the search text, or pass an empty string if no such data are available

textFragmentAfter - the text fragment after the search text, or pass an empty string if no such data are available

Throws:

java.lang.IllegalArgumentException - if invalid data are passed

Method Detail

getFoundText

public java.lang.String getFoundText()

Get the text which was found.

Returns:

the text which was found

getFoundAtAbsoluteIndex

public int getFoundAtAbsoluteIndex()

Get the absolute index (0..n-1).

Returns:

the absolute index (0..n-1)

getFoundAtLineNumber

public int getFoundAtLineNumber()

Get the line number (1..n).

Returns:

the line number (1..n)

getFoundAtLineIndex

public int getFoundAtLineIndex()

Get the index within the line (0..n-1).

Returns:

the index within the line (0..n-1)

getTextFragmentBefore

public java.lang.String getTextFragmentBefore()

Get the text fragment before the search text, or an empty string if no such data is available.

Returns:

the text fragment before the search text, or an empty string if no such data is available

getTextFragmentAfter

public java.lang.String getTextFragmentAfter()

Get the text fragment after the search text, or an empty string if no such data is available.

Returns:

the text fragment after the search text, or an empty string if no such data is available

toJsonObject

public JsonObject toJsonObject()

Get a JSON object of this instance.

Returns:

a JSON object of this instance

dumpToStdout

public void dumpToStdout()

Dump the content of this instance to stdout.

compareTo

public int compareTo(SearchTextInLinesResult otherInstance)

Compare the absolute index of this instance with the absolute index of another instance.

Specified by:

compareTo in interface java.lang.Comparable<SearchTextInLinesResult>

Parameters:

otherInstance - the other instance