oracle.jdeveloper.usage.event

Class FieldUsageEvent

java.lang.Object

oracle.jdeveloper.usage.event.UsageEvent

oracle.jdeveloper.usage.event.FieldUsageEvent

public class FieldUsageEvent
extends UsageEvent

The FieldUsageEvent describes the information about a field usage that is reported through the FieldUsageListener. It contains the URL, the start/end offsets of the usage, and a usage code describing the location the usage occurred, such as the field declaration.

Field Summary

Fields

Modifier and Type	Field and Description
static int	USAGE_FIELD_ACCESS Constant indicating that the usage is in a field access.
static int	USAGE_FIELD_DECLARATION Constant indicating that the usage is in a field declaration.

Fields inherited from class oracle.jdeveloper.usage.event.UsageEvent

_endOffset, _source, _startOffset, _url, _usageCode, USAGE_CANCELLED, USAGE_FAILED, USAGE_FINISHED, USAGE_KEYWORD_SKIPPED, USAGE_URL_SKIPPED

Constructor Summary

Constructors

Constructor and Description
FieldUsageEvent(UsageQueryTask source, int usageCode, java.net.URL url, int startOffset, int endOffset) Construct a new usage event.

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.String	usageCodeToString(int code) Return a human-readable version of the usage code.

Methods inherited from class oracle.jdeveloper.usage.event.UsageEvent

getEndOffset, getSource, getStartOffset, getURL, getUsageCode, toString

Methods inherited from class java.lang.Object

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

Field Detail

USAGE_FIELD_DECLARATION

public static final int USAGE_FIELD_DECLARATION

Constant indicating that the usage is in a field declaration.

See Also:

Constant Field Values

USAGE_FIELD_ACCESS

public static final int USAGE_FIELD_ACCESS

Constant indicating that the usage is in a field access.

See Also:

Constant Field Values

Constructor Detail

FieldUsageEvent

public FieldUsageEvent(UsageQueryTask source,
               int usageCode,
               java.net.URL url,
               int startOffset,
               int endOffset)

Construct a new usage event.

Parameters:

source - the query task

usageCode - the usage code describing this event

url - the URL where the event occurred

startOffset - the starting offset

endOffset - the ending offset

Method Detail

usageCodeToString

protected java.lang.String usageCodeToString(int code)

Return a human-readable version of the usage code.

Overrides:

usageCodeToString in class UsageEvent

Parameters:

code - the usage code

Returns:

human-readable version