ObjOut (MRules Javadoc 2.7.0 API)

java.lang.Object
- com.massa.util.ObjOut

```
public class ObjOut
extends Object
```
Dumps one or more object trees onto a print stream, showing objects identities, fields, etc.
The output is a human readable text, indented and wrapping objects' content with braces to take advantage of collapse/expand features of good editors.
Collections and arrays are processed specially to show their elements, not their raw fields. Strings, Dates, and various common classes are treated as values.
Some packages can be pruned to avoid wasting time drilling down within e.g. java.io.File's. A maximum depth can be set ; some objects can be pre-recorded to skip them.
Note : most operations are surrounded by try/catch that should prevent any Exception from being thrown.
Note 2 : May be invoked from within a debugger : dumps on console.
Example :
ObjOut.to("out.c").skip(session).prune("-com.ibm").dump(request, response).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`ObjOut.Handler`
`protected class`	`ObjOut.OutputDriver`
`protected class`	`ObjOut.OutputDriverHtml`
`protected static class`	`ObjOut.StdHandler`

Field Summary

Fields
Modifier and Type	Field and Description
`protected HashMap<Object,Object>`	`equs`
`protected boolean`	`includeStatic`
`protected static HashMap<Class<?>,Field[]>`	`knownFields`
`protected HashMap<Class<?>,ObjOut.Handler>`	`knownHandlers`
`protected int`	`level`
`protected int`	`maxLevel`
`protected int`	`maxLevelReached`
`protected boolean`	`mustClose`
`protected int`	`numExceptions`
`protected int`	`numLevelExceeded`
`protected ObjOut.OutputDriver`	`odrv`
`protected ArrayList<Pair<String,Boolean>>`	`pruningRules`
`protected PrintStream`	`ps`
`protected IdentityHashMap<Object,Integer>`	`seen`

Constructor Summary

Constructors
Constructor and Description

ObjOut()
Builds a dumper targeting System.out, pruning java.* and javax

Constructors
Constructor and Description
`ObjOut()` Builds a dumper targeting System.out, pruning java.* and javax

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Integer`	`assignOid(Object o)`
`protected Integer`	`assignOrRetrieveOid(Object o)`
`protected void`	`checkEqualities(Class<?> c, Object o)`
`String`	`dump(Object... os)` Dump passed objects to the pre-set stream, if it is not null.
`protected void`	`dump(String name, Class<?> expected, Object o, boolean endWithNewLine)`
`String`	`dumpField(Object o, String field)`
`String`	`dumpWithMem(boolean forget, Object... os)` Dump passed objects to the pre-set stream, if it is not null.
`protected boolean`	`enterObjectContent(Object o, Class<?> c)` Decide whether to actually drill down to an object's content (returning true/false accordingly) and if so, prints an opening text and update the level.
`protected Field[]`	`getFieldsFor(Object o, Class<?> c)`
`protected ObjOut.Handler`	`getHandlerFor(Object o, Class<?> c)`
`int`	`getMaxLevel()`
`ObjOut`	`html()`
`protected void`	`leaveObjectContent(boolean endWithNewLine)`
`ObjOut`	`noStatics()`
`protected void`	`prclass(Class<?> c)`
`protected void`	`printValue(Class<?> c, Object o, boolean endWithNewLine)`
`ObjOut`	`prune(String rules)` Adds pruning rules based on package names.
`protected Field[]`	`rawGetFieldsFor(Object o, Class<?> c)`
`ObjOut`	`resetPruning()`
`ObjOut`	`setMaxLevel(int maxLevel)`
`protected boolean`	`shouldPrune(String className)`
`ObjOut`	`skip(Object... os)` Records passed objects to the 'already seen' list, causing their content to be skipped when dumping later on. e.g : `new ObjOut().to("file.c").skip(session).dump(request)`
`ObjOut`	`statics()`
`ObjOut`	`text()`
`static ObjOut`	`to(File f)` Sets this dumper to output to a file
`static ObjOut`	`to(OutputStream os, boolean mustClose)` Sets this dumper to output to a stream
`ObjOut`	`to(PrintStream newPs, boolean newMustClose)` Sets this dumper to output to a given print stream and replaces previous values of ps and mustClose.
`static ObjOut`	`to(String fileName)` Sets this dumper to output to the file specified by its name
`static ObjOut`	`to(Writer w, boolean mustClose)` Sets this dumper to output to a stream
`static String`	`toString(Object o)` Convenience method to automatically do a toString on an object.
`static String`	`toString(Object o, int maxLevel)` Convenience method to automatically do a toString at maxLevel of introspection on an object.

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

Field Detail

knownHandlers

protected final HashMap<Class<?>,ObjOut.Handler> knownHandlers

knownFields

protected static final HashMap<Class<?>,Field[]> knownFields

pruningRules

protected ArrayList<Pair<String,Boolean>> pruningRules

ps
```
protected PrintStream ps
```

mustClose
```
protected boolean mustClose
```

maxLevel
```
protected int maxLevel
```

includeStatic
```
protected boolean includeStatic
```

seen

protected IdentityHashMap<Object,Integer> seen

equs
```
protected HashMap<Object,Object> equs
```

level
```
protected int level
```

maxLevelReached
```
protected int maxLevelReached
```

numExceptions
```
protected int numExceptions
```

numLevelExceeded
```
protected int numLevelExceeded
```

odrv
```
protected ObjOut.OutputDriver odrv
```

Constructor Detail
- ObjOut
```
public ObjOut()
```
  Builds a dumper targeting System.out, pruning java.* and javax.*

Method Detail

resetPruning
```
public ObjOut resetPruning()
```

prune
```
public ObjOut prune(String rules)
```
Adds pruning rules based on package names. Rules are encoded in a string, separated with commas, and starting either with a '+' or a '-' : the former means "drill down", the latter "skip".

statics
```
public ObjOut statics()
```

noStatics
```
public ObjOut noStatics()
```

to
```
public ObjOut to(PrintStream newPs,
                 boolean newMustClose)
```
Sets this dumper to output to a given print stream and replaces previous values of ps and mustClose.

to

public static ObjOut to(Writer w,
                        boolean mustClose)

Sets this dumper to output to a stream

to

public static ObjOut to(OutputStream os,
                        boolean mustClose)

Sets this dumper to output to a stream

to
```
public static ObjOut to(File f)
```
Sets this dumper to output to a file

to
```
public static ObjOut to(String fileName)
```
Sets this dumper to output to the file specified by its name

skip
```
public ObjOut skip(Object... os)
```
Records passed objects to the 'already seen' list, causing their content to be skipped when dumping later on. e.g :
new ObjOut().to("file.c").skip(session).dump(request)

dump
```
public String dump(Object... os)
```
Dump passed objects to the pre-set stream, if it is not null. Noop otherwise.

dumpWithMem
```
public String dumpWithMem(boolean forget,
                          Object... os)
```
Dump passed objects to the pre-set stream, if it is not null. Noop otherwise.

Parameters:

forget - if true, 'seen' objects are cleared.

dumpField

public String dumpField(Object o,
                        String field)

shouldPrune

protected boolean shouldPrune(String className)

prclass
```
protected void prclass(Class<?> c)
```

getHandlerFor

protected ObjOut.Handler getHandlerFor(Object o,
                                       Class<?> c)

printValue

protected void printValue(Class<?> c,
                          Object o,
                          boolean endWithNewLine)

checkEqualities

protected void checkEqualities(Class<?> c,
                               Object o)

enterObjectContent
```
protected boolean enterObjectContent(Object o,
                                     Class<?> c)
```
Decide whether to actually drill down to an object's content (returning true/false accordingly) and if so, prints an opening text and update the level.

leaveObjectContent

protected void leaveObjectContent(boolean endWithNewLine)

assignOid

protected Integer assignOid(Object o)

assignOrRetrieveOid

protected Integer assignOrRetrieveOid(Object o)

dump

protected void dump(String name,
                    Class<?> expected,
                    Object o,
                    boolean endWithNewLine)

rawGetFieldsFor

protected Field[] rawGetFieldsFor(Object o,
                                  Class<?> c)

getFieldsFor

protected Field[] getFieldsFor(Object o,
                               Class<?> c)

getMaxLevel
```
public int getMaxLevel()
```

setMaxLevel

public ObjOut setMaxLevel(int maxLevel)

html
```
public ObjOut html()
```

text
```
public ObjOut text()
```

toString
```
public static String toString(Object o,
                              int maxLevel)
```
Convenience method to automatically do a toString at maxLevel of introspection on an object.

toString
```
public static String toString(Object o)
```
Convenience method to automatically do a toString on an object.

Class ObjOut

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

knownHandlers

knownFields

pruningRules

ps

mustClose

maxLevel

includeStatic

seen

equs

level

maxLevelReached

numExceptions

numLevelExceeded

odrv

Constructor Detail

ObjOut

Method Detail

resetPruning

prune

statics

noStatics

to

to

to

to

to

skip

dump

dumpWithMem

dumpField

shouldPrune

prclass

getHandlerFor

printValue

checkEqualities

enterObjectContent

leaveObjectContent

assignOid

assignOrRetrieveOid

dump

rawGetFieldsFor

getFieldsFor

getMaxLevel

setMaxLevel

html

text

toString

toString