Top Inners Fields Methods
org.eclipse.jetty.util.component

public Interface Dumpable

Known Direct Subinterfaces
org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.resource.ResourceFactory.LifeCycle
Known Direct Implementers
org.eclipse.jetty.util.component.DumpableAttributes, org.eclipse.jetty.util.component.DumpableCollection, org.eclipse.jetty.util.component.Environment.Named, org.eclipse.jetty.util.jndi.NamingDump, org.eclipse.jetty.util.resource.FileSystemPool, org.eclipse.jetty.util.ssl.SslContextFactory, org.eclipse.jetty.util.ssl.SslSelectionDump, org.eclipse.jetty.util.ssl.SslSelectionDump.CaptionedList, org.eclipse.jetty.util.thread.QueuedThreadPool, org.eclipse.jetty.util.thread.ReservedThreadExecutor, org.eclipse.jetty.util.thread.ScheduledExecutorScheduler, org.eclipse.jetty.util.Attributes.Lazy, org.eclipse.jetty.util.AttributesMap, org.eclipse.jetty.util.ConcurrentPool, org.eclipse.jetty.util.component.ClassLoaderDump
Annotations
@ManagedObject:Dumpable Object
Imports
java.io.IOException, java.lang.reflect.Array, java.nio.file.Path, java.util.Arrays, .Collection, .Iterator, .Map, .Objects, java.util.stream.Stream, org.eclipse.jetty.util.StringUtil, .TypeUtil, org.eclipse.jetty.util.annotation.ManagedObject, .ManagedOperation

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
Dumpable.DumpableContainer

DumpableContainer A Dumpable that is a container of beans can implement this interface to allow it to refine which of its beans can be dumped.

Field Summary

Modifier and TypeField and Description
public static final String
KEY

Method Summary

Modifier and TypeMethod and Description
public default String
dump()

public void
dump(Appendable
The appendable to dump to
out, String
The indent to apply after any new lines.
indent)

Dump this object (and children) into an Appendable using the provided indent after any new lines.

public static String

Returns:

The dumped string
dump(Dumpable
The dumpable to dump
dumpable)

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

public static void
dumpContainer(Appendable out, String indent, Container object, boolean last)

public static void
dumpIterable(Appendable out, String indent, Iterable<?> iterable, boolean last)

public static void
dumpMapEntries(Appendable out, String indent, Map<?, ?> map, boolean last)

public static void
dumpObject(Appendable
The Appendable to dump to
out, Object
The object to dump.
o)

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

public static void
dumpObjects(Appendable
the Appendable to dump to
out, String
The indent to apply after any new lines
indent, 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.
object, Object...
Items to be dumped as children of the object, in addition to any discovered children of object
extraChildren)

Dump an Object, it's contained items and additional items to an Appendable.

public default String

Returns:

the representation of self
dumpSelf()

The description of this/self found in the dump.

public static Dumpable
named(String name, Object object)

Field Detail

KEYback to summary
public static final String KEY

Method Detail

dumpback to summary
public default String dump()
Annotations
@ManagedOperation:Dump the nested Object state as a String
impact:INFO
dumpback to summary
public 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:Appendable

The appendable to dump to

indent:String

The indent to apply after any new lines.

Exceptions
IOException:
if unable to write to Appendable
dumpback to summary
public static String dump(Dumpable dumpable)

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

Parameters
dumpable:Dumpable

The dumpable to dump

Returns:String

The dumped string

dumpContainerback to summary
public static void dumpContainer(Appendable out, String indent, Container object, boolean last) throws IOException
dumpIterableback to summary
public static void dumpIterable(Appendable out, String indent, Iterable<?> iterable, boolean last) throws IOException
dumpMapEntriesback to summary
public static void dumpMapEntries(Appendable out, String indent, Map<?, ?> map, boolean last) throws IOException
dumpObjectback to summary
public static void dumpObject(Appendable out, Object o) throws IOException

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

Parameters
out:Appendable

The Appendable to dump to

o:Object

The object to dump.

Exceptions
IOException:
May be thrown by the Appendable
dumpObjectsback to summary
public 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:Appendable

the Appendable to dump to

indent:String

The indent to apply after any new lines

object: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:Object[]

Items to be dumped as children of the object, in addition to any discovered children of object

Exceptions
IOException:
May be thrown by the Appendable
dumpSelfback to summary
public default String dumpSelf()

The description of this/self found in the dump. Allows for alternative representation of Object other then .toString() where the long form output of toString() is represented in a cleaner way within the dump infrastructure.

Returns:String

the representation of self

namedback to summary
public static Dumpable named(String name, Object object)
org.eclipse.jetty.util.component back to summary

public Interface Dumpable.DumpableContainer

extends Dumpable
Known Direct Implementers
org.eclipse.jetty.util.component.ContainerLifeCycle
DumpableContainer A Dumpable that is a container of beans can implement this interface to allow it to refine which of its beans can be dumped.

Field Summary

Inherited from org.eclipse.jetty.util.component.Dumpable:
KEY

Method Summary

Modifier and TypeMethod and Description
public default boolean
isDumpable(Object o)

Inherited from org.eclipse.jetty.util.component.Dumpable:
dumpdumpdumpdumpContainerdumpIterabledumpMapEntriesdumpObjectdumpObjectsdumpSelfnamed

Method Detail

isDumpableback to summary
public default boolean isDumpable(Object o)