Package com.redwood.scheduler.api.search
Interface SearchResult
-
public interface SearchResultThe result of a search. This interface provides methods to determine if the search succeeded, where the result was found, and to retrieve the line that contained the result in various formats.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetLineBase64()Get the complete text of the line containing the result, as it occurred (the original bit representation), encoded as Base64.longgetLineNumber()Get the line number at which the result occurred.StringgetLineText()Get the complete text of the line containing the result, as a string.longgetNextByteOffset()Get the byte offset for a next search for continuing immediately after the returned data from this result.booleanwasFound()Was anything found.
-
-
-
Method Detail
-
wasFound
boolean wasFound()
Was anything found.- Returns:
- true if a result was found, false otherwise.
-
getLineNumber
long getLineNumber()
Get the line number at which the result occurred. This will return -1 if nothing was found.- Returns:
- the line number, or -1 if nothing was found.
-
getNextByteOffset
long getNextByteOffset()
Get the byte offset for a next search for continuing immediately after the returned data from this result. For use with the SearchOptions.ByteOffset option.- Returns:
- the byte offset, or -1 if nothing was found.
-
getLineText
String getLineText()
Get the complete text of the line containing the result, as a string. This will return null if nothing was found.- Returns:
- the complete line, or null.
-
getLineBase64
String getLineBase64()
Get the complete text of the line containing the result, as it occurred (the original bit representation), encoded as Base64. This will return null if nothing was found.- Returns:
- the complete line, or null.
-
-