ml.alternet.facet.Presentable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of alternet-tools Show documentation

Alternet Tools include discovery service tools, concurrent and locking tools, and more

The newest version!

package ml.alternet.facet;

/**
 * A Presentable object can provide a pretty string representation of
 * itself.
 *
 * 
 * Usefull for console and logs outputs.
 * 
 *
 * @author Philippe Poulard
 */
public interface Presentable {

    /**
     * Return a pretty string representation of this.
     *
     * @return A new string buffer.
     */
    default StringBuilder toPrettyString() {
        return toPrettyString(new StringBuilder());
    }

    /**
     * Append a pretty string representation of this to the given buffer.
     *
     * @param buf
     *            The buffer to append to.
     *
     * @return The buffer given.
     */
    StringBuilder toPrettyString(StringBuilder buf);

}