ObjectRecorder (JChart2D API documentation, Version 3.2.2)

java.lang.Object
- java.lang.Thread
- - info.monitorenter.reflection.ObjectRecorder

All Implemented Interfaces:

Runnable
```
public class ObjectRecorder
extends Thread
```
The ObjectRecorder takes records(inspections) of an objects state using reflection and accessibility- framework.
It's strategy is to:
```
  - try to set any field accessible.
  - try to get the value of the field.
  - if not succeed: try to invoke a bean- conform getter.
  - if NoSuchMethod, it's useless (no implementation of MagicClazz here).
 
```
Furthermore the ObjectRecorder has a history - size (buffer) and an adjustable distance between each inspection.
Version:

$Revision: 1.10 $

Author:

Achim Westermann

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class ObjectRecorder.ObjectInspection
Data container for the inspection of the internal intance.
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Nested Classes
Modifier and Type	Class and Description
`class`	`ObjectRecorder.ObjectInspection` Data container for the inspection of the internal intance.

Field Summary

Fields
Modifier and Type	Field and Description
`protected IRingBuffer<ObjectRecorder.ObjectInspection>`	`m_buffer` Fast buffer to store recorded fiels.
`protected EventListenerList`	`m_changeListeners` The listeners on this recorder.
`protected Field[]`	`m_fields` The fields to inspect on the instance.
`protected long`	`m_interval` The time - interval between to inspections of the Object.
`protected Object`	`m_toinspect` The instance to inspect.
`protected static boolean`	`VERBOSE` Verbosity constant.

Fields inherited from class java.lang.Thread
MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor and Description

ObjectRecorder(Object toinspect, long interval)
Creates an instance that will inspect the given Object in the given time interval.

Constructors
Constructor and Description
`ObjectRecorder(Object toinspect, long interval)` Creates an instance that will inspect the given Object in the given time interval.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(ChangeListener x)` Adds a change listener that will be informed about new recordings of the inspected instances.
`boolean`	`equals(Object obj)`
`protected void`	`fireChange()` Informs the listeners about a change of this instance.
`TimeStampedValue[]`	`getAttributeHistory(String attributeName)` The History returned by this Method represents the past of the field specified by attributeName.
`String[]`	`getAttributeNames()` Returns the names of the fields to inspect.
`Object`	`getInspected()` Returns the inspected instance.
`TimeStampedValue`	`getLastValue(String fieldname)` Returns the last recorded value taken from the given field along with the time stamp identifying the time this value was recored.
`IRingBuffer<ObjectRecorder.ObjectInspection>`	`getRingBuffer()` Returns the internal fifo buffer that stores the `ObjectRecorder.ObjectInspection` instances that have been done.
`int`	`hashCode()`
`void`	`inspect()` Makes a record of the state of the object specified in the constructor.
`void`	`removeChangeListener(ChangeListener x)` Removes the given listener for changes of the inpsected instance.
`void`	`run()`
`void`	`setHistoryLength(int length)` Define the amount of recorded states of the Object to inspect that remain in memory.
`void`	`setInterval(long sleeptime)` Sets the interval for inpection of the instance to inspect in ms.
`String`	`toString()`

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, yield

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - VERBOSE
```
protected static final boolean VERBOSE
```
    Verbosity constant.
    
    See Also:
    
    Constant Field Values
  - m_buffer
```
protected IRingBuffer<ObjectRecorder.ObjectInspection> m_buffer
```
    Fast buffer to store recorded fiels.
  - m_changeListeners
```
protected EventListenerList m_changeListeners
```
    The listeners on this recorder.
  - m_fields
```
protected Field[] m_fields
```
    The fields to inspect on the instance.
  - m_interval
```
protected long m_interval
```
    The time - interval between to inspections of the Object.
  - m_toinspect
```
protected Object m_toinspect
```
    The instance to inspect.
- Constructor Detail
  - ObjectRecorder
```
public ObjectRecorder(Object toinspect,
                      long interval)
```
    Creates an instance that will inspect the given Object in the given time interval.
    
    Parameters:
    
    toinspect - the instance to inspect.
    
    interval - the interval of inspection in ms.
- Method Detail
  - addChangeListener
```
public void addChangeListener(ChangeListener x)
```
    Adds a change listener that will be informed about new recordings of the inspected instances.
    
    Parameters:
    
    x - the change listener that will be informed about new recordings of the inspected instances.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - fireChange
```
protected void fireChange()
```
    Informs the listeners about a change of this instance.
  - getAttributeHistory
```
public TimeStampedValue[] getAttributeHistory(String attributeName)
                                       throws NoSuchAttributeException
```
    The History returned by this Method represents the past of the field specified by attributeName. It starts from low index with the newest values taken from the inspected Object and ends with the oldest.
    
    Parameters:
    
    attributeName - field name of the internal instance to inspect.
    
    Returns:
    
    An array filled with TimeStampedValues that represent the past of the last inspections of the field with attributeName.
    
    Throws:
    
    NoSuchAttributeException - if the attribute / field described by the given argument does not exist on the internal Object to instpect.
    
    See Also:
    
    getInspected()
  - getAttributeNames
```
public String[] getAttributeNames()
```
    Returns the names of the fields to inspect.
    
    Returns:
    
    the names of the fields to inspect.
  - getInspected
```
public Object getInspected()
```
    Returns the inspected instance.
    
    Returns:
    
    the inspected instance.
  - getLastValue
```
public TimeStampedValue getLastValue(String fieldname)
                              throws NoSuchAttributeException
```
    Returns the last recorded value taken from the given field along with the time stamp identifying the time this value was recored.
    
    Parameters:
    
    fieldname - the field whose value was recorded.
    
    Returns:
    
    the last recorded value taken from the given field along with the time stamp identifying the time this value was recored.
    
    Throws:
    
    NoSuchAttributeException - if no such field exists on the Object to inspect.
  - getRingBuffer
```
public IRingBuffer<ObjectRecorder.ObjectInspection> getRingBuffer()
```
    Returns the internal fifo buffer that stores the ObjectRecorder.ObjectInspection instances that have been done.
    
    Returns:
    
    the internal fifo buffer that stores the ObjectRecorder.ObjectInspection instances that have been done.
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
    
    See Also:
    
    Object.hashCode()
  - inspect
```
public void inspect()
```
    Makes a record of the state of the object specified in the constructor. The new record is stored in a RingBuffer and contains all retrieveable values of the Object specified in the constructor. Reflection is used to get the values. If a field is private it's value is tried to be taken from the Object by invoking a getter - method conform with the bean - specification: The name of the method has to be "get" followed by the name of the field with first letter upper case.
  - removeChangeListener
```
public void removeChangeListener(ChangeListener x)
```
    Removes the given listener for changes of the inpsected instance.
    
    Parameters:
    
    x - the listener to remove.
  - run
```
public void run()
```
    Specified by:
    
    run in interface Runnable
    
    Overrides:
    
    run in class Thread
    
    See Also:
    
    Runnable.run()
  - setHistoryLength
```
public void setHistoryLength(int length)
```
    Define the amount of recorded states of the Object to inspect that remain in memory.
    Default value is 100.
    
    Parameters:
    
    length - the amount of recorded states of the Object to inspect that remain in memory.
  - setInterval
```
public void setInterval(long sleeptime)
```
    Sets the interval for inpection of the instance to inspect in ms.
    
    Parameters:
    
    sleeptime - the interval for inpection of the instance to inspect in ms.
    
    See Also:
    
    ObjectRecorder(Object, long)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Thread
    
    See Also:
    
    Object.toString()

Class ObjectRecorder

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Field Summary

Fields inherited from class java.lang.Thread

Constructor Summary

Method Summary

Methods inherited from class java.lang.Thread

Methods inherited from class java.lang.Object

Field Detail

VERBOSE

m_buffer

m_changeListeners

m_fields

m_interval

m_toinspect

Constructor Detail

ObjectRecorder

Method Detail

addChangeListener

equals

fireChange

getAttributeHistory

getAttributeNames

getInspected

getLastValue

getRingBuffer

hashCode

inspect

removeChangeListener

run

setHistoryLength

setInterval

toString