Package org.hibernate.search.util.common.spi

Interface ToStringTreeAppendable

All Known Implementing Classes:

AbstractProjectionDefinition, ConstantProjectionDefinition, DistanceProjectionDefinition, DistanceProjectionDefinition.MultiValued, DistanceProjectionDefinition.SingleValued, DistanceProjectionDefinition.WrappedValued, FieldProjectionDefinition, FieldProjectionDefinition.AccumulatedValued, FieldProjectionDefinition.MultiValued, FieldProjectionDefinition.SingleValued, ObjectProjectionDefinition, ObjectProjectionDefinition.MultiValued, ObjectProjectionDefinition.SingleValued, ObjectProjectionDefinition.WrappedValued

@Incubating
public interface ToStringTreeAppendable

Implemented by classes that can be rendered to a string representing a tree.

Method Summary

Modifier and Type	Method	Description
void	appendTo(ToStringTreeAppender appender)	Appends information about this to the given appender.
default String	toStringTree()	A reasonable implementation of Object.toString() relying on appendTo(ToStringTreeAppender).

Method Details

appendTo

void appendTo(ToStringTreeAppender appender)

Appends information about this to the given appender.

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

Implementations should assume that calls to ToStringTreeAppender.startObject()/ToStringTreeAppender.endObject() for this are handled by the caller.

Parameters:

appender - A ToStringTreeAppender.

toStringTree

default String toStringTree()

A reasonable implementation of Object.toString() relying on appendTo(ToStringTreeAppender).

Returns:

A string representation of the given appendable.