SizeEstimator (JSimpleDB Utility Classes 2.1.7 API)

java.lang.Object
- org.jsimpledb.util.SizeEstimator

```
public class SizeEstimator
extends Object
```
Used to estimate Java object memory usage in bytes.
For classes that contain references to other objects, what exactly is included in an object's "size" is defined on a case-by-case basis.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOOLEAN_SIZE`
`static int`	`BYTE_SIZE`
`static int`	`CHAR_SIZE`
`static int`	`DOUBLE_SIZE`
`static int`	`FLOAT_SIZE`
`static int`	`INT_SIZE`
`static int`	`LONG_SIZE`
`static int`	`SHORT_SIZE`

Constructor Summary

Constructors
Constructor and Description

SizeEstimator()

Constructors
Constructor and Description
`SizeEstimator()`

Method Summary

Methods
Modifier and Type	Method and Description
`SizeEstimator`	`add(boolean[] array)` Add the size of the given array object.
`SizeEstimator`	`add(byte[] array)` Add the size of the given array object.
`SizeEstimator`	`add(char[] array)` Add the size of the given array object.
`SizeEstimator`	`add(double[] array)` Add the size of the given array object.
`SizeEstimator`	`add(float[] array)` Add the size of the given array object.
`SizeEstimator`	`add(int[] array)` Add the size of the given array object.
`SizeEstimator`	`add(long value)` Adjust the total by an arbitrary amount.
`SizeEstimator`	`add(long[] array)` Add the size of the given array object.
`SizeEstimator`	`add(Object[] array)` Add the size of the given array object.
`SizeEstimator`	`add(short[] array)` Add the size of the given array object.
`SizeEstimator`	`add(SizeEstimating obj)` Add the size of the given `SizeEstimating` object.
`SizeEstimator`	`addArray(int elementSize, int length)` Add the size of a non-null array having elements with the given size and the specified length.
`SizeEstimator`	`addArrayListField(ArrayList<?> list)` Add the size of an `ArrayList` field, assuming `ArrayList.trimToSize()` has been invoked.
`SizeEstimator`	`addBooleanField()` Add the size of a primitive `boolean` field.
`SizeEstimator`	`addByteField()` Add the size of a primitive `byte` field.
`SizeEstimator`	`addCharField()` Add the size of a primitive `char` field.
`SizeEstimator`	`addDoubleField()` Add the size of a primitive `double` field.
`SizeEstimator`	`addField(boolean[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(byte[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(char[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(double[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(float[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(int[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(long[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(Object[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(short[] array)` Add the size of the given array field.
`SizeEstimator`	`addField(SizeEstimating field)` Add the size of a `SizeEstimating` reference field.
`SizeEstimator`	`addFloatField()` Add the size of a primitive `float` field.
`SizeEstimator`	`addIntField()` Add the size of a primitive `int` field.
`SizeEstimator`	`addLongField()` Add the size of a primitive `long` field.
`SizeEstimator`	`addObjectOverhead()` Add the basic overhead for any object.
`SizeEstimator`	`addReferenceField()` Add the size of an object reference field.
`SizeEstimator`	`addShortField()` Add the size of a primitive `short` field.
`SizeEstimator`	`addTreeMapField(TreeMap<?,?> map)` Add the size of a `TreeMap` field.
`SizeEstimator`	`addTreeSetField(TreeSet<?> set)` Add the size of a `TreeSet` field.
`int`	`getObjectOverhead()` Get the basic overhead for any object.
`int`	`getReferenceSize()` Get the size of an object reference.
`long`	`getTotal()` Get the estimated total size.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BOOLEAN_SIZE
```
public static final int BOOLEAN_SIZE
```
    See Also:
    Constant Field Values
  - BYTE_SIZE
```
public static final int BYTE_SIZE
```
    See Also:
    Constant Field Values
  - CHAR_SIZE
```
public static final int CHAR_SIZE
```
    See Also:
    Constant Field Values
  - SHORT_SIZE
```
public static final int SHORT_SIZE
```
    See Also:
    Constant Field Values
  - INT_SIZE
```
public static final int INT_SIZE
```
    See Also:
    Constant Field Values
  - FLOAT_SIZE
```
public static final int FLOAT_SIZE
```
    See Also:
    Constant Field Values
  - LONG_SIZE
```
public static final int LONG_SIZE
```
    See Also:
    Constant Field Values
  - DOUBLE_SIZE
```
public static final int DOUBLE_SIZE
```
    See Also:
    Constant Field Values
- Constructor Detail
  - SizeEstimator
```
public SizeEstimator()
```
- Method Detail
  - getTotal
```
public long getTotal()
```
    Get the estimated total size.
    
    Returns:
    current size estimate
  - getObjectOverhead
```
public int getObjectOverhead()
```
    Get the basic overhead for any object.
    The implementation in SizeEstimator returns 12.
    
    Returns:
    minimum size of any Object
  - getReferenceSize
```
public int getReferenceSize()
```
    Get the size of an object reference.
    The implementation in SizeEstimator returns 4.
    
    Returns:
    the size of an object reference
  - addObjectOverhead
```
public SizeEstimator addObjectOverhead()
```
    Add the basic overhead for any object.
    The implementation in SizeEstimator adds the amount returned by getObjectOverhead().
    
    Returns:
    this instance
  - add
```
public SizeEstimator add(long value)
```
    Adjust the total by an arbitrary amount.
    
    Parameters:
    value - amount to add to the total
    
    Returns:
    this instance
  - addBooleanField
```
public final SizeEstimator addBooleanField()
```
    Add the size of a primitive boolean field.
    
    Returns:
    this instance
  - addByteField
```
public final SizeEstimator addByteField()
```
    Add the size of a primitive byte field.
    
    Returns:
    this instance
  - addCharField
```
public final SizeEstimator addCharField()
```
    Add the size of a primitive char field.
    
    Returns:
    this instance
  - addShortField
```
public final SizeEstimator addShortField()
```
    Add the size of a primitive short field.
    
    Returns:
    this instance
  - addIntField
```
public final SizeEstimator addIntField()
```
    Add the size of a primitive int field.
    
    Returns:
    this instance
  - addFloatField
```
public final SizeEstimator addFloatField()
```
    Add the size of a primitive float field.
    
    Returns:
    this instance
  - addLongField
```
public final SizeEstimator addLongField()
```
    Add the size of a primitive long field.
    
    Returns:
    this instance
  - addDoubleField
```
public final SizeEstimator addDoubleField()
```
    Add the size of a primitive double field.
    
    Returns:
    this instance
  - addReferenceField
```
public final SizeEstimator addReferenceField()
```
    Add the size of an object reference field.
    This is for the field itself, not including any object it may reference if not null
    
    Returns:
    this instance
  - addArray
```
public SizeEstimator addArray(int elementSize,
                     int length)
```
    Add the size of a non-null array having elements with the given size and the specified length.
    
    Parameters:
    elementSize - size of one array element
    length - array length
    
    Returns:
    this instance
    
    Throws:
    
    IllegalArgumentException - if elementSize is non-positive or length is negative
  - add
```
public SizeEstimator add(boolean[] array)
```
    Add the size of the given array object.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - add
```
public SizeEstimator add(byte[] array)
```
    Add the size of the given array object.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - add
```
public SizeEstimator add(char[] array)
```
    Add the size of the given array object.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - add
```
public SizeEstimator add(short[] array)
```
    Add the size of the given array object.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - add
```
public SizeEstimator add(int[] array)
```
    Add the size of the given array object.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - add
```
public SizeEstimator add(float[] array)
```
    Add the size of the given array object.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - add
```
public SizeEstimator add(long[] array)
```
    Add the size of the given array object.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - add
```
public SizeEstimator add(double[] array)
```
    Add the size of the given array object.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - add
```
public SizeEstimator add(Object[] array)
```
    Add the size of the given array object.
    This does not include the size of any objects referred to by elements in the array.
    
    Parameters:
    array - array object
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if array is null
  - addField
```
public SizeEstimator addField(boolean[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - addField
```
public SizeEstimator addField(byte[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - addField
```
public SizeEstimator addField(char[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - addField
```
public SizeEstimator addField(short[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - addField
```
public SizeEstimator addField(int[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - addField
```
public SizeEstimator addField(float[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - addField
```
public SizeEstimator addField(long[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - addField
```
public SizeEstimator addField(double[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - addField
```
public SizeEstimator addField(Object[] array)
```
    Add the size of the given array field.
    This includes the size of the array field itself, plus the size of the referred-to array if not null. This does not include the size of any objects referred to by elements in the array.
    
    Parameters:
    array - array object, possibly null
    
    Returns:
    this instance
  - add
```
public SizeEstimator add(SizeEstimating obj)
```
    Add the size of the given SizeEstimating object.
    This method just invokes SizeEstimating.addTo().
    
    Parameters:
    obj - object to measure
    
    Returns:
    this instance
    
    Throws:
    
    NullPointerException - if obj is null
  - addField
```
public SizeEstimator addField(SizeEstimating field)
```
    Add the size of a SizeEstimating reference field.
    This includes the size of the field itself, plus the size of the referred-to object (according to SizeEstimating.addTo() if field is not null.
    
    Parameters:
    field - field to measure, possibly null
    
    Returns:
    this instance
  - addArrayListField
```
public SizeEstimator addArrayListField(ArrayList<?> list)
```
    Add the size of an ArrayList field, assuming ArrayList.trimToSize() has been invoked.
    This includes the size of the array field itself, plus the size of the referred-to array if list is not null.
    This does not include any objects referred to by the list.
    
    Parameters:
    list - ArrayList object, possibly null
    
    Returns:
    this instance
  - addTreeMapField
```
public SizeEstimator addTreeMapField(TreeMap<?,?> map)
```
    Add the size of a TreeMap field.
    This includes the size of the field itself, plus the size of the referred-to TreeMap if map is not null.
    This does not include the sizes of the key and value objects contained in the TreeMap.
    
    Parameters:
    map - TreeMap object, possibly null
    
    Returns:
    this instance
  - addTreeSetField
```
public SizeEstimator addTreeSetField(TreeSet<?> set)
```
    Add the size of a TreeSet field.
    This includes the size of the field itself, plus the size of the referred-to TreeSet if set is not null.
    This does not include the sizes of the objects contained in the TreeSet.
    
    Parameters:
    set - TreeSet object, possibly null
    
    Returns:
    this instance

Class SizeEstimator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BOOLEAN_SIZE

BYTE_SIZE

CHAR_SIZE

SHORT_SIZE

INT_SIZE

FLOAT_SIZE

LONG_SIZE

DOUBLE_SIZE

Constructor Detail

SizeEstimator

Method Detail

getTotal

getObjectOverhead

getReferenceSize

addObjectOverhead

add

addBooleanField

addByteField

addCharField

addShortField

addIntField

addFloatField

addLongField

addDoubleField

addReferenceField

addArray

add

add

add

add

add

add

add

add

add

addField

addField

addField

addField

addField

addField

addField

addField

addField

add

addField

addArrayListField

addTreeMapField

addTreeSetField