info.magnolia.templating.inspector

Class Inspector

java.lang.Object

info.magnolia.templating.inspector.Inspector

public class Inspector
extends Object

Inspector is a utility that dumps objects into readable format.

Inspector is able to print objects in plain text and HTML format by default. No other formats are now supported.

Inspector comes with default implementations of ValueFormatters that can handle the following objects:

• Null values
• Primitives
• Strings
• Dates (Date and Calendar)
• ContentMaps
• Nodes
• Propertys
• Arrays
• Collections
• Maps

Inspector uses Service Provider Interface pattern for handling registered ValueFormatters.

Developers may register custom ValueFormatter implementations the following way:

• Create text file info.magnolia.templating.inspector.spi.ValueFormatter$Definition under META-INF/services directory.
• Open the file and add custom ValueFormatter implementation.

See Also:

ValueFormatter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Inspector.AbstractValueFormatter<T> Abstract implementation of the ValueFormatter.
static class	Inspector.ArrayValueFormatter Array type description.
static class	Inspector.BooleanValueFormatter Boolean type description.
static class	Inspector.CalendarValueFormatter Calendar type description.
static class	Inspector.CharValueFormatter Character type description.
static class	Inspector.CollectionValueFormatter Collection type description.
static class	Inspector.ContentMapValueFormatter ContentMap type description.
static class	Inspector.DateValueFormatter Date type description.
static class	Inspector.MapValueFormatter type description.
static class	Inspector.NodeValueFormatter Node type description.
static class	Inspector.NullValueFormatter Type description for null values.
static class	Inspector.NumberValueFormatter Number type description.
static class	Inspector.ObjectValueFormatter Object type description.
static class	Inspector.PropertyValueFormatter Property type description.
static class	Inspector.StringValueFormatter String type description.

Method Summary

Modifier and Type	Method and Description
static String	dump(Object obj)
static String	dump(Object obj, int depth)
static String	dump(Object obj, int depth, boolean asHtml)

Methods inherited from class java.lang.Object

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

Method Detail

dump

public static String dump(Object obj)

dump

public static String dump(Object obj,
                          int depth)

dump

public static String dump(Object obj,
                          int depth,
                          boolean asHtml)