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

Interface ToStringTreeAppender

All Known Implementing Classes:

ToStringTreeBuilder

@Incubating
public interface ToStringTreeAppender

An appender for use in ToStringTreeAppendable.

Method Summary

Modifier and Type	Method	Description
ToStringTreeAppender	attribute(String name, Object value)	Appends a nested, named attribute.
ToStringTreeAppender	endList()	Ends a nested list.
ToStringTreeAppender	endObject()	Ends a nested object.
ToStringTreeAppender	startList()	Starts a nested, unnamed list.
ToStringTreeAppender	startList(String name)	Starts a nested, named object.
ToStringTreeAppender	startObject()	Starts a nested, unnamed object.
ToStringTreeAppender	startObject(String name)	Starts a nested, named object.
ToStringTreeAppender	value(Object value)	Appends a nested, unnamed value.

Method Detail

attribute

ToStringTreeAppender attribute(String name,
                               Object value)

Appends a nested, named attribute.

Parameters:

name - The name of the attribute to append.

value - The value of the attribute to append.

Returns:

this, for method chaining.

value

ToStringTreeAppender value(Object value)

Appends a nested, unnamed value.

Parameters:

value - The value to append.

Returns:

this, for method chaining.

startObject

ToStringTreeAppender startObject()

Starts a nested, unnamed object.

Returns:

this, for method chaining.

startObject

ToStringTreeAppender startObject(String name)

Starts a nested, named object.

Parameters:

name - The name of the object (type, ...).

Returns:

this, for method chaining.

endObject

ToStringTreeAppender endObject()

Ends a nested object.

Returns:

this, for method chaining.

startList

ToStringTreeAppender startList()

Starts a nested, unnamed list.

Returns:

this, for method chaining.

startList

ToStringTreeAppender startList(String name)

Starts a nested, named object.

Parameters:

name - The name of the list (type, ...).

Returns:

this, for method chaining.

endList

ToStringTreeAppender endList()

Ends a nested list.

Returns:

this, for method chaining.