Module org.refcodes.runtime

Package org.refcodes.runtime

Class DumpBuilder

java.lang.Object

org.refcodes.runtime.DumpBuilder

All Implemented Interfaces:

org.refcodes.mixin.ObjectAccessor, org.refcodes.mixin.ObjectAccessor.ObjectBuilder<DumpBuilder>, org.refcodes.mixin.ObjectAccessor.ObjectMutator, org.refcodes.mixin.ObjectAccessor.ObjectProperty

public class DumpBuilder
extends Object
implements org.refcodes.mixin.ObjectAccessor.ObjectProperty, org.refcodes.mixin.ObjectAccessor.ObjectBuilder<DumpBuilder>

The DumpBuilder assists you in inspecting the content of an object. Creates a Map containing the dump of an object's the member variable's values, the names being the keys and the values being the member variables' values.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.ObjectAccessor

org.refcodes.mixin.ObjectAccessor.ObjectBuilder<B extends org.refcodes.mixin.ObjectAccessor.ObjectBuilder<B>>, org.refcodes.mixin.ObjectAccessor.ObjectMutator, org.refcodes.mixin.ObjectAccessor.ObjectProperty

Constructor Summary

Constructors

Constructor	Description
DumpBuilder()

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	asDump(Object aObj)	Dumps the the provided object into a Map which is returned as result (the builder needs not to be instantiated).
Object	getObject()
void	setObject(Object aObject)
Map<String,String>	toDump()	Dumps the state of the contained object (as of setObject(Object)) into a Map which is returned as result.
Map<String,String>	toDump(Object aObj)	Dumps the state of the provided object into a Map which is returned as result.
protected static Map<String,String>	toDump(Object aObj, Map<String,String> aDump)	Dumps the state of the implementing instance into the provided Map which is returned as result.
DumpBuilder	withObject(Object aObject)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.refcodes.mixin.ObjectAccessor.ObjectProperty

letObject

Constructor Detail

DumpBuilder

public DumpBuilder()

Method Detail

getObject

public Object getObject()

Specified by:

getObject in interface org.refcodes.mixin.ObjectAccessor

setObject

public void setObject(Object aObject)

Specified by:

setObject in interface org.refcodes.mixin.ObjectAccessor.ObjectMutator

withObject

public DumpBuilder withObject(Object aObject)

Specified by:

withObject in interface org.refcodes.mixin.ObjectAccessor.ObjectBuilder<DumpBuilder>

toDump

public Map<String,String> toDump(Object aObj)

Dumps the state of the provided object into a Map which is returned as result.

Parameters:

aObj - The object for which to create the dump.

Returns:

The Map with the dumped properties of the implementing instance.

toDump

public Map<String,String> toDump()

Dumps the state of the contained object (as of setObject(Object)) into a Map which is returned as result.

Returns:

The Map with the dumped properties of the implementing instance.

asDump

public static Map<String,String> asDump(Object aObj)

Dumps the the provided object into a Map which is returned as result (the builder needs not to be instantiated).

Parameters:

aObj - The object for which to create the dump.

Returns:

The Map with the dumped properties of the implementing instance.

toDump

protected static Map<String,String> toDump(Object aObj,
                                                 Map<String,String> aDump)

Dumps the state of the implementing instance into the provided Map which is returned as result. This default implementation uses reflection to create a basic dump. Map properties are processed but not recursively digged into. Existing properties are overwritten in case shadowing super-class's properties.

Parameters:

aObj - The object to be dumped.

aDump - the Map where to dump to.

Returns:

The Map with the dumped properties of the implementing instance.