• Home
• org.hibernate.search
• hibernate-search-util-common
• 8.0.0.Alpha1
• source code
• ToStringTreeAppendable.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.hibernate.search.util.common.spi.ToStringTreeAppendable Maven / Gradle / Ivy

/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Red Hat Inc. and Hibernate Authors
 */
package org.hibernate.search.util.common.spi;

import org.hibernate.search.util.common.annotation.Incubating;
import org.hibernate.search.util.common.impl.ToStringStyle;
import org.hibernate.search.util.common.impl.ToStringTreeBuilder;

/**
 * Implemented by classes that can be rendered to a string representing a tree.
 */
@Incubating
public interface ToStringTreeAppendable {

	/**
	 * Appends information about {@code this} to the given {@code appender}.
	 * 

	 * WARNING: This generally shouldn't be called directly, as {@link ToStringTreeAppender}
	 * will automatically call this method for {@link ToStringTreeAppendable} values passed
	 * to {@link ToStringTreeAppender#attribute(String, Object)}/{@link ToStringTreeAppender#value(Object)}.
	 * 

	 * Implementations should assume that calls to
	 * {@link ToStringTreeAppender#startObject()}/{@link ToStringTreeAppender#endObject()}
	 * for {@code this} are handled by the caller.
	 *
	 * @param appender A {@link ToStringTreeAppender}.
	 */
	void appendTo(ToStringTreeAppender appender);

	/**
	 * A reasonable implementation of {@link Object#toString()} relying on {@link #appendTo(ToStringTreeAppender)}.
	 * @return A string representation of the given {@code appendable}.
	 */
	default String toStringTree() {
		return new ToStringTreeBuilder( ToStringStyle.inlineDelimiterStructure() ).value( this ).toString();
	}

}