Package org.hibernate.search.engine.search.projection.definition.spi

Class ObjectProjectionDefinition<P,T>

java.lang.Object

org.hibernate.search.engine.search.projection.definition.spi.AbstractProjectionDefinition<P>

org.hibernate.search.engine.search.projection.definition.spi.ObjectProjectionDefinition<P,T>

All Implemented Interfaces:

AutoCloseable, ProjectionDefinition<P>, ToStringTreeAppendable

Direct Known Subclasses:

ObjectProjectionDefinition.MultiValued, ObjectProjectionDefinition.SingleValued

@Incubating
public abstract class ObjectProjectionDefinition<P,T>
extends AbstractProjectionDefinition<P>
implements AutoCloseable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ObjectProjectionDefinition.MultiValued<T>
static final class	ObjectProjectionDefinition.SingleValued<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final CompositeProjectionDefinition<T>	delegate
protected final String	fieldPath

Method Summary

Modifier and Type	Method	Description
void	appendTo(ToStringTreeAppender appender)	Appends information about this to the given appender.
void	close()
protected abstract boolean	multi()
protected String	type()

Methods inherited from class org.hibernate.search.engine.search.projection.definition.spi.AbstractProjectionDefinition

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hibernate.search.engine.search.projection.definition.ProjectionDefinition

create

Methods inherited from interface org.hibernate.search.util.common.spi.ToStringTreeAppendable

toStringTree

Field Details

fieldPath

protected final String fieldPath

delegate

protected final CompositeProjectionDefinition<T> delegate

Method Details

type

protected String type()

Specified by:

type in class AbstractProjectionDefinition<P>

appendTo

public void appendTo(ToStringTreeAppender appender)

Description copied from interface: ToStringTreeAppendable

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.

Specified by:

appendTo in interface ToStringTreeAppendable

Overrides:

appendTo in class AbstractProjectionDefinition<P>

Parameters:

appender - A ToStringTreeAppender.

multi

protected abstract boolean multi()

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception