org.sandev.basics.structs
Class CacheMemSummaryStruct

java.lang.Object
  org.sandev.basics.structs.CacheMemSummaryStruct

Direct Known Subclasses:

CacheMemSummary

public class CacheMemSummaryStruct
extends java.lang.Object

A memory usage summary for a class of message stored.

summary fields: classname quantity kbytes average
This message has the following verb forms: query collection
declared printname: Cache Memory Summary Item
help text: A memory usage summary based on the class of the message stored.

Field Summary

protected double	average The average memory weight of a class instance in kilobytes.
protected java.lang.String	classname The short classname of the cached message type being summarized.
protected double	kbytes The total amount of memory in kilobytes used by all instances of this class.
protected int	quantity A count of how many instances of the given class are cached.

Constructor Summary

CacheMemSummaryStruct()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

classname

protected java.lang.String classname

The short classname of the cached message type being summarized.

declared invalid value: "SANDEV_INVALID_CLASSNAME"
Length in characters, normal: 40 max: 80
help text: The short classname of the cached message type being summarized.

quantity

protected int quantity

A count of how many instances of the given class are cached.

range match expression: >= 0
help text: A count of how many instances of the given class are cached.

kbytes

protected double kbytes

The total amount of memory in kilobytes used by all instances of this class.

range match expression: >= 0.0
help text: The total amount of memory in kilobytes used by all instances of this class.

average

protected double average

The average memory weight of a class instance in kilobytes.

range match expression: >= 0.0
help text: The average memory weight of a class instance in kilobytes.

Constructor Detail

CacheMemSummaryStruct

public CacheMemSummaryStruct()