Package org.eclipse.jetty.util.component

Interface Dumpable

All Known Implementing Classes:

AttributesMap, ContainerLifeCycle, DumpableCollection, EatWhatYouKill, ExecutorSizedThreadPool, ExecutorThreadPool, MonitoredQueuedThreadPool, QueuedThreadPool, ScheduledExecutorScheduler, SslContextFactory

@ManagedObject("Dumpable Object")
public interface Dumpable

Field Summary

Fields

Modifier and Type	Field	Description
static String	KEY

Method Summary

Modifier and Type	Method	Description
default String	dump()
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
static String	dump(Dumpable dumpable)	Utility method to implement dump() by calling dump(Appendable, String)
static void	dumpObject(Appendable out, Object o)	Dump just an Object (but not it's contained items) to an Appendable.
static void	dumpObjects(Appendable out, String indent, Object object, Object... extraChildren)	Dump an Object, it's contained items and additional items to an Appendable.

Field Detail

KEY

static final String KEY

See Also:

Constant Field Values

Method Detail

dump

@ManagedOperation(value="Dump the nested Object state as a String",
                  impact="INFO")
default String dump()

dump

void dump(Appendable out,
          String indent)
   throws IOException

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException

dump

static String dump(Dumpable dumpable)

Utility method to implement dump() by calling dump(Appendable, String)

Parameters:

dumpable - The dumpable to dump

Returns:

The dumped string

dumpObject

static void dumpObject(Appendable out,
                       Object o)
                throws IOException

Dump just an Object (but not it's contained items) to an Appendable.

Parameters:

out - The Appendable to dump to

o - The object to dump.

Throws:

IOException - May be thrown by the Appendable

dumpObjects

static void dumpObjects(Appendable out,
                        String indent,
                        Object object,
                        Object... extraChildren)
                 throws IOException

Dump an Object, it's contained items and additional items to an Appendable. If the object in an Iterable or an Array, then its contained items are also dumped.

Parameters:

out - the Appendable to dump to

indent - The indent to apply after any new lines

object - 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 object

Throws:

IOException - May be thrown by the Appendable