public class UsageEvent
extends java.lang.Object
UsageEvent
is used to return usage notifications
to the client who initiated the usage query. The client will
typically receive one or more result events (i.e., ClassUsageEvent),
followed by a UsageEvent of usage code USAGE_FINISHED when the
query is complete.Modifier and Type | Field and Description |
---|---|
protected int |
_endOffset
The ending offset of the usage location.
|
protected UsageQueryTask |
_source
The query task associated with this event.
|
protected int |
_startOffset
The starting offset of the usage location.
|
protected java.net.URL |
_url
The URL where the usage occurred.
|
protected int |
_usageCode
The location where the usage occurred (i.e., USAGE_IMPORT)
|
static int |
USAGE_CANCELLED
Constant for the usage code indicating that the query was cancelled.
|
static int |
USAGE_FAILED
Constant for the usage code indicating that the query has failed
due to an exception.
|
static int |
USAGE_FINISHED
Constant for the usage code indicating that the query is finished.
|
static int |
USAGE_KEYWORD_SKIPPED
Constant for the usage code indicating that the keyword occurrence
specified by this event (URL, offsets), was skipped, as it could
not be validated.
|
static int |
USAGE_URL_SKIPPED
Constant for the usage code indicating the the given URL was
skipped in the usage search, as it was not a Java file.
|
Constructor and Description |
---|
UsageEvent(UsageQueryTask source,
int usageCode)
Construct a new usage event with no applicable start/end offsets.
|
UsageEvent(UsageQueryTask source,
int usageCode,
java.net.URL url)
Construct a new usage event with an associated URL, but no applicable
start/end offsets.
|
UsageEvent(UsageQueryTask source,
int usageCode,
java.net.URL url,
int startOffset,
int endOffset)
Construct a new usage event.
|
Modifier and Type | Method and Description |
---|---|
int |
getEndOffset()
Fetch the ending offset of the usage location.
|
UsageQueryTask |
getSource()
Fetch the query task that is associated with this event.
|
int |
getStartOffset()
Fetch the starting offset of the usage location.
|
java.net.URL |
getURL()
Fetch the URL where the usage occurred
|
int |
getUsageCode()
Fetch the usage code that occurred.
|
java.lang.String |
toString()
Returns a string representation of this event for debugging.
|
protected java.lang.String |
usageCodeToString(int code)
Return a human-readable version of the usage code.
|
protected UsageQueryTask _source
protected int _usageCode
protected java.net.URL _url
protected int _startOffset
protected int _endOffset
public static final int USAGE_FINISHED
public static final int USAGE_CANCELLED
public static final int USAGE_FAILED
public static final int USAGE_URL_SKIPPED
public static final int USAGE_KEYWORD_SKIPPED
public UsageEvent(UsageQueryTask source, int usageCode)
source
- the query taskusageCode
- the usage code describing this eventpublic UsageEvent(UsageQueryTask source, int usageCode, java.net.URL url)
source
- the query taskurl
- the URL for the eventusageCode
- the usage code describing this eventpublic UsageEvent(UsageQueryTask source, int usageCode, java.net.URL url, int startOffset, int endOffset)
source
- the query taskusageCode
- the usage code describing this eventurl
- the URL for the eventstartOffset
- the starting offsetendOffset
- the ending offsetpublic UsageQueryTask getSource()
public int getUsageCode()
public java.net.URL getURL()
public int getStartOffset()
public int getEndOffset()
public java.lang.String toString()
toString
in class java.lang.Object
protected java.lang.String usageCodeToString(int code)
code
- the usage code