oracle.ide.debugger.extender.evaluator

Interface DebuggerExtenderData

All Superinterfaces:

oracle.ideimpl.debugger.extender.evaluator.CommonDataBase, Displayable

public interface DebuggerExtenderData
extends oracle.ideimpl.debugger.extender.evaluator.CommonDataBase, Displayable

DebuggerExtenderData represents a data item from a debuggee as supplied by the debugger. Use Displayable.getIcon() to retrieve the icon of this object Use Displayable.getShortLabel() to retrieve the name of this object Use Displayable.getLongLabel() to retrieve the description (value) of this object

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

oracle.ideimpl.debugger.extender.evaluator.CommonDataBase.DataKind

Method Summary

Modifier and Type	Method and Description
void	adjustRange() Bring up the adjust range dialog.
boolean	canAdjustRange() Determine if it's possible to adjust the range of this object
java.lang.String	canGotoActualType() Determine if it's possible to go to the source file of the actual type of this object
java.lang.String	canGotoDeclaredType() Determine if it's possible to go to the source file of the declared type of this object
java.lang.String	canGotoField() Determine if it's possible to go to the source location of the field IFF this object is a field
boolean	canInspect() Determine if this object can be inspected
boolean	canInspectClassLoader() Determine if the classloader of this object can be inspected
boolean	canModifyValue() Determine if it's possible to modify any values of this object
boolean	canShowObjectPreferences() Determine if it's possible to show the ObjectPreferences dialog on this object
boolean	canToggleValue() Determine if it's possible to toggle the value of this object
java.lang.String	canViewAnnotations() Determine if it's possible to view the annotations of this object
boolean	canViewAnnotationsForClass() Determine if it's possible to view the annotations of the class of this object
boolean	canViewWholeValue() Determine if the whole value of this object can be shown
boolean	canWatch() Determine if this object can be watched
boolean	canWatchClassLoader() Determine if the classloader of this object can be watched
java.lang.String	getActualType() Get the runtime-type of this object.
java.lang.String	getAddress() Get the address of this object, if possible
java.util.List<? extends DebuggerExtenderData>	getChildren() Get the display children of this object.
java.util.List<? extends DebuggerExtenderData>	getDeclaredFields() Get a list of declared fields for an object of kind OBJECT.
java.lang.String	getDeclaredType() Get the declared type of this object.
DebuggerExtenderData	getField(java.lang.String fieldName) Get a field by name from an object of kind OBJECT.
java.util.List<? extends DebuggerExtenderData>	getFields() Get a list of fields for an object of kind OBJECT.
java.lang.String	getFullyQualifiedActualType() Get the fully qualified runtime-type of this object.
java.lang.String	getFullyQualifiedDeclaredType() Get the fully qualified declared type of this object.
java.lang.String	getHexValue() Get the hex representation of this object, if possible
oracle.ideimpl.debugger.extender.evaluator.CommonDataBase.DataKind	getKind() Get the kind of this object, if possible
int	getRangeCount() Return the item count for the range that will be displayed for array type data items
int	getRangeStart() Return the start of the range that will be returned for array type data items.
void	gotoActualType() Attempt to go to the source file of the actual type of this object
void	gotoDeclaredType() Attempt to go to the source file of the declared type of this object
void	gotoField() Attempt to go to the source location of the field IFF this object is a field
void	inspect() Put up an inspector for this object
void	inspectClassLoader() Put up an inspector for the classloader of this object
boolean	mayHaveChildren() Find out if this object may have display children, which doesn't imply it actually has children, just that it may.
void	modifyValue() Show the dialog where details of this object can be modified.
void	setDisplayName(java.lang.String displayName) Set the display name of an object, which will become the name returned by getShortLabel().
boolean	setMaximumRange() if the data item represents an array of some description, set the range to it's maximum size.
boolean	setRange(int start, int count) Programmatically adjust the range (contrast to adjustRange() which brings up a dialog).
void	showObjectPreferences() Attempt to show the ObjectPreferences dialog on this object.
void	toggleValue() Toggle the value of this object, if possible.
void	viewAnnotations() View the annotations of this object in a special dialog
void	viewAnnotationsForClass() View the annotations of the class of this object in a special dialog
void	viewWholeValue() View the whole value of this object in a special dialog
void	watch() Set a watch for this object
void	watchClassLoader() Set a watch for the classloader of this object

Methods inherited from interface oracle.ide.model.Displayable

getAttributedLabel, getIcon, getLongLabel, getShortLabel, getToolTipText, toString

Method Detail

mayHaveChildren

boolean mayHaveChildren()

Find out if this object may have display children, which doesn't imply it actually has children, just that it may.

Specified by:

mayHaveChildren in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if this object may have children

getChildren

java.util.List<? extends DebuggerExtenderData> getChildren()

Get the display children of this object. The list of children will be filtered by the current display settings

Specified by:

getChildren in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

A list of children, null if the evaluator backing this object has expired

getActualType

java.lang.String getActualType()

Get the runtime-type of this object.

Specified by:

getActualType in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

The type of this object as it is at runtime, or an empty String if the type is not known, or null if the evaluator backing this object has expired

getFullyQualifiedActualType

java.lang.String getFullyQualifiedActualType()

Get the fully qualified runtime-type of this object.

Specified by:

getFullyQualifiedActualType in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

The type of this object as it is at runtime, or an empty String if the type is not known, or null if the evaluator backing this object has expired

getDeclaredType

java.lang.String getDeclaredType()

Get the declared type of this object.

Specified by:

getDeclaredType in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

The type of this object as it is declared, or an empty String if the type is not known, or null if the evaluator backing this object has expired

getFullyQualifiedDeclaredType

java.lang.String getFullyQualifiedDeclaredType()

Get the fully qualified declared type of this object.

Specified by:

getFullyQualifiedDeclaredType in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

The type of this object as it is declared, or an empty String if the type is not known, or null if the evaluator backing this object has expired

getHexValue

java.lang.String getHexValue()

Get the hex representation of this object, if possible

Specified by:

getHexValue in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

The hex representation, or an empty String if the hex representation is not known, or null if the evaluator backing this object has expired

getAddress

java.lang.String getAddress()

Get the address of this object, if possible

Specified by:

getAddress in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

The address of this object, or an empty String if the address is not known, or null if the evaluator backing this object has expired

getKind

oracle.ideimpl.debugger.extender.evaluator.CommonDataBase.DataKind getKind()

Get the kind of this object, if possible

Specified by:

getKind in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

The kind of this object or null if it's not known

inspect

void inspect()

Put up an inspector for this object

Specified by:

inspect in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canInspect

boolean canInspect()

Determine if this object can be inspected

Specified by:

canInspect in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if this object can be inspected

watch

void watch()

Set a watch for this object

Specified by:

watch in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canWatch

boolean canWatch()

Determine if this object can be watched

Specified by:

canWatch in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if this object can be watched

inspectClassLoader

void inspectClassLoader()

Put up an inspector for the classloader of this object

Specified by:

inspectClassLoader in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canInspectClassLoader

boolean canInspectClassLoader()

Determine if the classloader of this object can be inspected

Specified by:

canInspectClassLoader in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if the classloader of this object can be inspected

watchClassLoader

void watchClassLoader()

Set a watch for the classloader of this object

Specified by:

watchClassLoader in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canWatchClassLoader

boolean canWatchClassLoader()

Determine if the classloader of this object can be watched

Specified by:

canWatchClassLoader in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if the classloader of this object can be watched

viewWholeValue

void viewWholeValue()

View the whole value of this object in a special dialog

Specified by:

viewWholeValue in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canViewWholeValue

boolean canViewWholeValue()

Determine if the whole value of this object can be shown

Specified by:

canViewWholeValue in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if the whole value can be shown

gotoDeclaredType

void gotoDeclaredType()

Attempt to go to the source file of the declared type of this object

Specified by:

gotoDeclaredType in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canGotoDeclaredType

java.lang.String canGotoDeclaredType()

Determine if it's possible to go to the source file of the declared type of this object

Specified by:

canGotoDeclaredType in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

Null if it's not possible to go to the source, or a String that can be displayed in a menu item for the goto action

gotoActualType

void gotoActualType()

Attempt to go to the source file of the actual type of this object

Specified by:

gotoActualType in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canGotoActualType

java.lang.String canGotoActualType()

Determine if it's possible to go to the source file of the actual type of this object

Specified by:

canGotoActualType in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

Null if it's not possible to go to the source, or a String that can be displayed in a menu item for the goto action

gotoField

void gotoField()

Attempt to go to the source location of the field IFF this object is a field

Specified by:

gotoField in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canGotoField

java.lang.String canGotoField()

Determine if it's possible to go to the source location of the field IFF this object is a field

Specified by:

canGotoField in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

Null if it's not possible to go to the location of the field, or a String that can be displayed in a menu item for the goto action

adjustRange

void adjustRange()

Bring up the adjust range dialog. The caller is responsible for refreshing the display of this object on return of this method by calling getChildren which will return only the children in the newly specified range

Specified by:

adjustRange in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

setRange

boolean setRange(int start,
                 int count)

Programmatically adjust the range (contrast to adjustRange() which brings up a dialog). The caller is responsible for refreshing the display of this object on return of this method by calling getChildren which will only return the children in the newly specified range

Specified by:

setRange in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Parameters:

start - offset at which the range will begin

count - number of elements the range will contain.

Returns:

boolean true if the range is valid; boolean false if start + count exceeds the number of items in the array.

See Also:

adjustRange(), getRangeStart(), getRangeCount()

setMaximumRange

boolean setMaximumRange()

if the data item represents an array of some description, set the range to it's maximum size.

Specified by:

setMaximumRange in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

getRangeStart

int getRangeStart()

Return the start of the range that will be returned for array type data items.

Specified by:

getRangeStart in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

the start of the range, or -1 if data item is not an array

getRangeCount

int getRangeCount()

Return the item count for the range that will be displayed for array type data items

Specified by:

getRangeCount in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

the item count for the range, or -1 if the data item is not an array

canAdjustRange

boolean canAdjustRange()

Determine if it's possible to adjust the range of this object

Specified by:

canAdjustRange in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if it's possible to adjust the range

showObjectPreferences

void showObjectPreferences()

Attempt to show the ObjectPreferences dialog on this object. A successful completion of the dialog will trigger a call to DebuggerWindowProvider.refresh() as the sign that the custom windows need to be refreshed

Specified by:

showObjectPreferences in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canShowObjectPreferences

boolean canShowObjectPreferences()

Determine if it's possible to show the ObjectPreferences dialog on this object

Specified by:

canShowObjectPreferences in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if it's possible to show the ObjectPreferences dialog

toggleValue

void toggleValue()

Toggle the value of this object, if possible. A successful completion of the toggle action will trigger a call to DebuggerWindowProvider.refresh() as the sign that the custom windows need to be refreshed

Specified by:

toggleValue in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canToggleValue

boolean canToggleValue()

Determine if it's possible to toggle the value of this object

Specified by:

canToggleValue in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if it's possible to toggle the value

viewAnnotations

void viewAnnotations()

View the annotations of this object in a special dialog

Specified by:

viewAnnotations in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canViewAnnotations

java.lang.String canViewAnnotations()

Determine if it's possible to view the annotations of this object

Specified by:

canViewAnnotations in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

Null if it's not possible to view the annotations, or a String that can be displayed in a menu item for the view action

viewAnnotationsForClass

void viewAnnotationsForClass()

View the annotations of the class of this object in a special dialog

Specified by:

viewAnnotationsForClass in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canViewAnnotationsForClass

boolean canViewAnnotationsForClass()

Determine if it's possible to view the annotations of the class of this object

Specified by:

canViewAnnotationsForClass in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if it's possible to view the annotations

modifyValue

void modifyValue()

Show the dialog where details of this object can be modified. A successful completion of the dialog will trigger a call to DebuggerWindowProvider.refresh() as the sign that the custom windows need to be refreshed

Specified by:

modifyValue in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

canModifyValue

boolean canModifyValue()

Determine if it's possible to modify any values of this object

Specified by:

canModifyValue in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

True if it's possible to modify any values

getFields

java.util.List<? extends DebuggerExtenderData> getFields()

Get a list of fields for an object of kind OBJECT. These are all the fields in the object and all its parents.

Specified by:

getFields in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

A list which can be null

getDeclaredFields

java.util.List<? extends DebuggerExtenderData> getDeclaredFields()

Get a list of declared fields for an object of kind OBJECT. These are all the fields in the object itself.

Specified by:

getDeclaredFields in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Returns:

A list which can be null

getField

DebuggerExtenderData getField(java.lang.String fieldName)

Get a field by name from an object of kind OBJECT. This will be the first field with the correct name in the class hierarchy.

Specified by:

getField in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Parameters:

fieldName - The name of the field

Returns:

A DebuggeeData or null if the field could not be found

setDisplayName

void setDisplayName(java.lang.String displayName)

Set the display name of an object, which will become the name returned by getShortLabel(). This is useful for controlling the displayed name when an object that is based on a complicated expression is inspected or watched.

Specified by:

setDisplayName in interface oracle.ideimpl.debugger.extender.evaluator.CommonDataBase

Parameters:

displayName - The new displayName of the object