org.sandev.TaskHeap.structs
Class HeapAccessSummaryStruct

java.lang.Object
  org.sandev.TaskHeap.structs.HeapAccessSummaryStruct

Direct Known Subclasses:

HeapAccessSummary

public class HeapAccessSummaryStruct
extends java.lang.Object

An overview of the heaps you have access to. This is a display class used to provide a summary of all heaps a user has access to.

This message is a tree of values.
summary fields: type heapName association.access association status lineNumber indent
This message has the following verb forms: collection
declared printname: Heap Access
help text: An overview of the heaps you have access to.

Field Summary

protected long	association The association this summary is describing.
protected HeapAccessSummaryStruct[]	children The children of this summary display.
protected long	heap The heap this summary is describing.
protected java.lang.String	heapName The name of the heap this summary is describing.
protected java.lang.String	indent The indent level represented as a string of underscores.
protected int	lineNumber The line number of this element within the overall tree.
protected HeapAccessSummaryStruct	parent The parent of this summary display.
protected int	status Whether this is is the current HeapAssociation or not.
protected int	type What type of access this sumary is describing.

Constructor Summary

HeapAccessSummaryStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

type

protected int type

What type of access this sumary is describing.

declared default value: TREEROOT

enumerated constant values:

• TREEROOT("TreeRoot") = 0
  
• HEAP("Heap") = 1
  
• ASSOC("Association") = 2
  

declared invalid value: -1
help text: What type of access this sumary is describing.

heap

protected long heap

The heap this summary is describing.

reference to class: org.sandev.TaskHeap.structs.HeapAttributesStruct
help text: The heap this summary is describing.

heapName

protected java.lang.String heapName

The name of the heap this summary is describing. This is copied separately since the user may only access one heap at a time so to see the names of all their heaps we need to copy that information into the summary.

Length in characters, normal: 30 max: 80
declared printname: name
help text: The name of the heap this summary is describing.

association

protected long association

The association this summary is describing.

reference to class: org.sandev.TaskHeap.structs.HeapAssociationStruct
help text: The association this summary is describing.

parent

protected HeapAccessSummaryStruct parent

The parent of this summary display.

this field holds a reference to the parent instance in the tree.
help text: The parent of this summary display.

children

protected HeapAccessSummaryStruct[] children

The children of this summary display.

this field holds child references in the tree.
help text: The children of this summary display.

indent

protected java.lang.String indent

The indent level represented as a string of underscores. These can be translated into spaces or other characters as needed to form a hard indent display.

help text: The indent level for this display element.

lineNumber

protected int lineNumber

The line number of this element within the overall tree.

declared printname: line number
help text: The line number of this element within the overall tree.

status

protected int status

Whether this is is the current HeapAssociation or not.

declared default value: AVAILABLE

enumerated constant values:

• AVAILABLE("Available") = 0
  
• SELECTED("Selected") = 1
  

"is" boolean methods are generated for this field.
declared invalid value: -1

Constructor Detail

HeapAccessSummaryStruct

public HeapAccessSummaryStruct()