|
Spatial DataBlade JAVA API v8.21 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EventLocation
Interface for associating an event with a program or data location.
If the API or a plugin provides event location information to the application, it does so by implementing this interface. The application can use this interface to obtain the location of any event that gets triggered.
Note that the results returned by the object will be valid only during the scope of each API method: the application will receive unpredictable results if it attempts to use the event location at any other time.
Field Summary | |
---|---|
static int |
CODE
If this value is returned by the method getColumnNumber, then this object refers to a code location. |
Method Summary | |
---|---|
int |
getColumnNumber()
Returns the column number where the current event ends. |
java.lang.String |
getEntityId()
The return value is the identifier of the entity in which the event is triggered. |
int |
getLineNumber()
Return the line number where the current event occurs. |
java.lang.String |
getSubEntityId()
The return value is the identifier of the subentity in which the event is triggered. |
Field Detail |
---|
static final int CODE
getColumnNumber()
,
getEntityId()
,
getSubEntityId()
,
Constant Field ValuesMethod Detail |
---|
java.lang.String getEntityId()
The return value is the identifier of the entity in which the event is triggered.
For example, if an error occurs while parsing a file, the the entity identifier is simply the file name. If an error is located in the context of the API's code, then the class name would be the entity identifier.
CODE
java.lang.String getSubEntityId()
The return value is the identifier of the subentity in which the event is triggered.
In a code context, the subentity is the method name where an event occurs.
CODE
int getLineNumber()
Return the line number where the current event occurs.
The return value is an approximation of the line number in the document entity where the event is triggered.
If possible, the implementor should provide the line position of the first character after the text associated with the event. The first line in the document is line 1.
getColumnNumber()
int getColumnNumber()
The return value is an approximation of the column number in the document entity where the event is triggered.
If possible, the implementor should provide the column position of the first character after the text associated with the event. The first column in a line is column 1.
This method returns EventLocation.CODE to indicate that this object refers to code rather than data location.
getLineNumber()
,
CODE
|
Spatial DataBlade JAVA API v8.21 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |