Module org.eclipse.jetty.util
Package org.eclipse.jetty.util.component

Interface Dumpable

All Known Subinterfaces:
Dumpable.DumpableContainer
All Known Implementing Classes:
AdaptiveExecutionStrategy, AttributeContainerMap, AttributesMap, ContainerLifeCycle, DumpableCollection, EatWhatYouKill, ExecutorThreadPool, KeyStoreScanner, MonitoredQueuedThreadPool, Pool, QueuedThreadPool, ReservedThreadExecutor, Scanner, ScheduledExecutorScheduler, SslContextFactory, SslContextFactory.Client, SslContextFactory.Server
@ManagedObject("Dumpable Object") public interface Dumpable

  • Field Details

  • Method Details

    • 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 - if unable to write to Appendable

    • 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

    • dumpSelf

      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:
      the representation of self

    • 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

    • dumpContainer

      static void dumpContainer(Appendable out, String indent, Container object, boolean last) throws IOException
      Throws:
      IOException

    • dumpIterable

      static void dumpIterable(Appendable out, String indent, Iterable<?> iterable, boolean last) throws IOException
      Throws:
      IOException

    • dumpMapEntries

      static void dumpMapEntries(Appendable out, String indent, Map<?,?> map, boolean last) throws IOException
      Throws:
      IOException

    • named

      static Dumpable named(String name, Object object)