org.eclipse.rse.core.subsystems
Interface IRemoteLineReference

All Known Subinterfaces:

IRemoteError, IRemoteOutput, IRemoteSearchResult

All Known Implementing Classes:

RemoteSearchResult

public interface IRemoteLineReference

This interface represents an object that can be used to jump into line in source

Method Summary

String	getAbsolutePath() Gets the path to the file that this output references if it references any.
int	getCharEnd() Get the end offset in a line corresponding to this reference
int	getCharStart() Get the start offset in a line corresponding to this reference
int	getLine() Gets the line number within a file that this references if it references any.
Object	getParent() Get the object that contains this object.

Method Detail

getAbsolutePath

public String getAbsolutePath()

Gets the path to the file that this output references if it references any. It may return null if no such association exists. This may be used to jump to an editor from a view which displays this

Returns:

the path of the referenced file if there is one

getLine

public int getLine()

Gets the line number within a file that this references if it references any. By default it should return 0. If no file association exists, it also returns 0. This may be used to jump into a location within an editor from a view which displays remote output.

Returns:

the line number within a referenced file if there is one.

getCharStart

public int getCharStart()

Get the start offset in a line corresponding to this reference. -1 indicates there is no offset

Returns:

the offset

getCharEnd

public int getCharEnd()

Get the end offset in a line corresponding to this reference. -1 indicates there is no offset

Returns:

the offset

getParent

public Object getParent()

Get the object that contains this object.

Returns:

the parent object