org.eclipse.ptp.etfw.feedback
Interface IFeedbackItem

All Known Implementing Classes:

AbstractFeedbackItem

public interface IFeedbackItem

An IFeedbackItem has some standard info, like name, file, lineNo, etc
And some variable data, which will fill in the (variable number of) other columns.

EXPERIMENTAL. This class or interface has been added as part of a work in progress. There is no guarantee that this API will work or that it will remain the same. We do not recommending using this API without consulting with the etfw.feedback team.

Since:

6.0

Method Summary

java.lang.String	getAttr(java.lang.String key)
java.util.List<IFeedbackItem>	getChildren()
java.lang.String	getDescription() A longer description
java.lang.String	getFile() Return full filename, should include project name
java.lang.String	getID() unique id for this type of item e.g. to use as parent id
org.eclipse.core.resources.IFile	getIFile()
int	getLineNoStart() an IFeedbackItem can have either a lineno range (start/end) or a Character start/end.
java.lang.String	getName()
java.lang.Object	getObject() allow for future expansion
java.lang.Object	getObject(java.lang.String key)
java.lang.String	getParentID() string which may be used to tell which item is parent; an artificial 'parent' node MAY be created for this
boolean	hasChildren()

Method Detail

getName

java.lang.String getName()

getChildren

java.util.List<IFeedbackItem> getChildren()

hasChildren

boolean hasChildren()

getFile

java.lang.String getFile()

Return full filename, should include project name

Returns:

getIFile

org.eclipse.core.resources.IFile getIFile()

Since:

5.0

getLineNoStart

int getLineNoStart()

an IFeedbackItem can have either a lineno range (start/end) or a Character start/end. If useLineNo() returns true, use getStartingLineNo(); If the lineNo range is more than on eline, getEndlingLineNo() will tell the last line.

Returns:

getID

java.lang.String getID()

unique id for this type of item e.g. to use as parent id

Returns:

getDescription

java.lang.String getDescription()

A longer description

getParentID

java.lang.String getParentID()

string which may be used to tell which item is parent; an artificial 'parent' node MAY be created for this

getObject

java.lang.Object getObject()

allow for future expansion

Since:

2.0

getAttr

java.lang.String getAttr(java.lang.String key)

Since:

5.0

getObject

java.lang.Object getObject(java.lang.String key)

Since:

5.0