Eclipse RSE Development Guide (Galileo) - SystemSearchLineMatch (RSE API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

RSE
Release 3.0

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.rse.services.clientserver.search
Class SystemSearchLineMatch


java.lang.Object
  
org.eclipse.rse.services.clientserver.search.SystemSearchLineMatch

public class SystemSearchLineMatch
extends Object
extends Object

This class holds information about search results for a line of text. Its instance variables are public so that we can access them without having to call methods (for performance reasons).

Constructor Summary

SystemSearchLineMatch ( String line, int lineNumber)
          Constructor to create a search result for a line.

Method Summary

void addEntry (int startOffset, int endOffset)
          Adds an entry.

String getLine ()
          Returns the line that matched.

int getLineNumber ()
          Returns the line number of the line that matched.

Iterator getMatches ()
          Gets the iterator for the matches in the line.

int getNumOfMatches ()
          Gets the number of matches in the line.

Methods inherited from class java.lang. Object

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

Constructor Detail

SystemSearchLineMatch

public SystemSearchLineMatch(
String line,
                             int lineNumber)

Constructor to create a search result for a line.

Parameters:: line - the line.; lineNumber - the line number.

Method Detail

getLine

public 
String getLine()

Returns the line that matched.

Returns:: the line.

getLineNumber

public int getLineNumber()

Returns the line number of the line that matched.

Returns:: the line number.

getMatches

public 
Iterator getMatches()

Gets the iterator for the matches in the line.

Returns:: the iterator over the list of matches.

getNumOfMatches

public int getNumOfMatches()

Gets the number of matches in the line.

Returns:: the number of matches.

addEntry

public void addEntry(int startOffset,
                     int endOffset)

Adds an entry.

Parameters:: startOffset - the offset from the beginning of the file where the match begins.; endOffset - the offset from the beginning of the file where the match ends.