@ManagedObject(value="Dumpable Object") public interface Dumpable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
KEY |
Modifier and Type | Method and Description |
---|---|
default java.lang.String |
dump() |
void |
dump(java.lang.Appendable out,
java.lang.String indent)
Dump this object (and children) into an Appendable using the provided indent after any new lines.
|
static java.lang.String |
dump(Dumpable dumpable)
Utility method to implement
dump() by calling dump(Appendable, String) |
static void |
dumpObject(java.lang.Appendable out,
java.lang.Object o)
Dump just an Object (but not it's contained items) to an Appendable.
|
static void |
dumpObjects(java.lang.Appendable out,
java.lang.String indent,
java.lang.Object object,
java.lang.Object... extraChildren)
Dump an Object, it's contained items and additional items to an
Appendable . |
default java.lang.String |
dumpSelf()
The description of this/self found in the dump.
|
static final java.lang.String KEY
@ManagedOperation(value="Dump the nested Object state as a String", impact="INFO") default java.lang.String dump()
void dump(java.lang.Appendable out, java.lang.String indent) throws java.io.IOException
out
- The appendable to dump toindent
- The indent to apply after any new lines.java.io.IOException
- if unable to write to Appendablestatic java.lang.String dump(Dumpable dumpable)
dump()
by calling dump(Appendable, String)
dumpable
- The dumpable to dumpdefault java.lang.String dumpSelf()
static void dumpObject(java.lang.Appendable out, java.lang.Object o) throws java.io.IOException
out
- The Appendable to dump too
- The object to dump.java.io.IOException
- May be thrown by the Appendablestatic void dumpObjects(java.lang.Appendable out, java.lang.String indent, java.lang.Object object, java.lang.Object... extraChildren) throws java.io.IOException
Appendable
.
If the object in an Iterable
or an Array
, then its contained items
are also dumped.out
- the Appendable to dump toindent
- The indent to apply after any new linesobject
- The object to dump. If the object is an instance
of Container
, Stream
, Iterable
, Array
or Map
,
then children of the object a recursively dumped.extraChildren
- Items to be dumped as children of the object, in addition to any discovered children of objectjava.io.IOException
- May be thrown by the AppendableCopyright © 1995–2023 Webtide. All rights reserved.