org.eclipse.jetty.util.component.Dumpable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation
Show all versions of aem-sdk-api Show documentation
The Adobe Experience Manager SDK
//
// ========================================================================
// Copyright (c) 1995-2022 Mort Bay Consulting Pty Ltd and others.
// ------------------------------------------------------------------------
// All rights reserved. This program and the accompanying materials
// are made available under the terms of the Eclipse Public License v1.0
// and Apache License v2.0 which accompanies this distribution.
//
// The Eclipse Public License is available at
// http://www.eclipse.org/legal/epl-v10.html
//
// The Apache License v2.0 is available at
// http://www.opensource.org/licenses/apache2.0.php
//
// You may elect to redistribute this code under either of these licenses.
// ========================================================================
//
package org.eclipse.jetty.util.component;
import java.io.IOException;
import java.lang.reflect.Array;
import java.util.Arrays;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import java.util.stream.Stream;
import org.eclipse.jetty.util.StringUtil;
import org.eclipse.jetty.util.annotation.ManagedObject;
import org.eclipse.jetty.util.annotation.ManagedOperation;
// @deprecated The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.
@ManagedObject("Dumpable Object")
@Deprecated(since = "2021-05-27")
public interface Dumpable {
String KEY = "key: +- bean, += managed, +~ unmanaged, +? auto, +: iterable, +] array, +@ map, +> undefined";
@ManagedOperation(value = "Dump the nested Object state as a String", impact = "INFO")
default String dump() {
return dump(this);
}
/**
* 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.
*
* @param out The appendable to dump to
* @param indent The indent to apply after any new lines.
* @throws IOException if unable to write to Appendable
*/
void dump(Appendable out, String indent) throws IOException;
/**
* Utility method to implement {@link #dump()} by calling {@link #dump(Appendable, String)}
*
* @param dumpable The dumpable to dump
* @return The dumped string
*/
static String dump(Dumpable dumpable) {
StringBuilder b = new StringBuilder();
try {
dumpable.dump(b, "");
} catch (IOException e) {
b.append(e.toString());
}
b.append(KEY);
return b.toString();
}
/**
* 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.
*
* @return the representation of self
*/
default String dumpSelf() {
return toString();
}
/**
* Dump just an Object (but not it's contained items) to an Appendable.
*
* @param out The Appendable to dump to
* @param o The object to dump.
* @throws IOException May be thrown by the Appendable
*/
static void dumpObject(Appendable out, Object o) throws IOException {
try {
String s;
if (o == null)
s = "null";
else if (o instanceof Dumpable) {
s = ((Dumpable) o).dumpSelf();
s = StringUtil.replace(s, "\r\n", "|");
s = StringUtil.replace(s, '\n', '|');
} else if (o instanceof Collection)
s = String.format("%s@%x(size=%d)", o.getClass().getName(), o.hashCode(), ((Collection) o).size());
else if (o.getClass().isArray())
s = String.format("%s@%x[size=%d]", o.getClass().getComponentType(), o.hashCode(), Array.getLength(o));
else if (o instanceof Map)
s = String.format("%s@%x{size=%d}", o.getClass().getName(), o.hashCode(), ((Map) o).size());
else {
s = String.valueOf(o);
s = StringUtil.replace(s, "\r\n", "|");
s = StringUtil.replace(s, '\n', '|');
}
if (o instanceof LifeCycle)
out.append(s).append(" - ").append((AbstractLifeCycle.getState((LifeCycle) o))).append("\n");
else
out.append(s).append("\n");
} catch (Throwable ex) {
out.append("=> ").append(ex.toString()).append("\n");
}
}
/**
* Dump an Object, it's contained items and additional items to an {@link Appendable}.
* If the object in an {@link Iterable} or an {@link Array}, then its contained items
* are also dumped.
*
* @param out the Appendable to dump to
* @param indent The indent to apply after any new lines
* @param object The object to dump. If the object is an instance
* of {@link Container}, {@link Stream}, {@link Iterable}, {@link Array} or {@link Map},
* then children of the object a recursively dumped.
* @param 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
*/
static void dumpObjects(Appendable out, String indent, Object object, Object... extraChildren) throws IOException {
dumpObject(out, object);
int extras = extraChildren == null ? 0 : extraChildren.length;
if (object instanceof Stream)
object = ((Stream) object).toArray();
if (object instanceof Array)
object = Arrays.asList((Object[]) object);
if (object instanceof Container) {
dumpContainer(out, indent, (Container) object, extras == 0);
}
if (object instanceof Iterable) {
dumpIterable(out, indent, (Iterable) object, extras == 0);
} else if (object instanceof Map) {
dumpMapEntries(out, indent, (Map) object, extras == 0);
}
if (extras == 0)
return;
int i = 0;
for (Object item : extraChildren) {
i++;
String nextIndent = indent + (i < extras ? "| " : " ");
out.append(indent).append("+> ");
if (item instanceof Dumpable)
((Dumpable) item).dump(out, nextIndent);
else
dumpObjects(out, nextIndent, item);
}
}
static void dumpContainer(Appendable out, String indent, Container object, boolean last) throws IOException {
Container container = object;
ContainerLifeCycle containerLifeCycle = container instanceof ContainerLifeCycle ? (ContainerLifeCycle) container : null;
for (Iterator© 2015 - 2024 Weber Informatics LLC | Privacy Policy