Package org.eclipse.jetty.util.component

Interface Dumpable

    • Method Detail

      • dump

        void dump​(Appendable out,
          String indent)
   throws IOException
        Deprecated.
        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

      • dumpSelf

        default String dumpSelf()
        Deprecated.
        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
        Deprecated.
        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
        Deprecated.
        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