oracle.jdeveloper.usage.event

Class ConstructorUsageEvent

java.lang.Object

oracle.jdeveloper.usage.event.UsageEvent

oracle.jdeveloper.usage.event.ConstructorUsageEvent

public class ConstructorUsageEvent
extends UsageEvent

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	USAGE_CONSTRUCTOR_DECLARATION Constant indicating that the usage is a constructor declaration.
static int	USAGE_CONSTRUCTOR_NEW Constant indicating that the usage is a constructor invocation through "new (...)".
static int	USAGE_CONSTRUCTOR_SUPER Constant indicating that the usage is a constructor invocation through "super(...)".
static int	USAGE_CONSTRUCTOR_THIS Constant indicating that the usage is a constructor invocation through "this(...)".

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
ConstructorUsageEvent(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_CONSTRUCTOR_DECLARATION

public static final int USAGE_CONSTRUCTOR_DECLARATION

Constant indicating that the usage is a constructor declaration.

See Also:

Constant Field Values

USAGE_CONSTRUCTOR_THIS

public static final int USAGE_CONSTRUCTOR_THIS

Constant indicating that the usage is a constructor invocation through "this(...)".

See Also:

Constant Field Values

USAGE_CONSTRUCTOR_SUPER

public static final int USAGE_CONSTRUCTOR_SUPER

Constant indicating that the usage is a constructor invocation through "super(...)".

See Also:

Constant Field Values

USAGE_CONSTRUCTOR_NEW

public static final int USAGE_CONSTRUCTOR_NEW

Constant indicating that the usage is a constructor invocation through "new (...)".

See Also:

Constant Field Values

Constructor Detail

ConstructorUsageEvent

public ConstructorUsageEvent(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