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

Class ConstantProjectionDefinition<T>

java.lang.Object

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

org.hibernate.search.engine.search.projection.definition.spi.ConstantProjectionDefinition<T>

All Implemented Interfaces:

ProjectionDefinition<T>, ToStringTreeAppendable

@Incubating
public final class ConstantProjectionDefinition<T>
extends AbstractProjectionDefinition<T>

Method Summary

Modifier and Type	Method	Description
void	appendTo(ToStringTreeAppender appender)	Appends information about this to the given appender.
SearchProjection<T>	create(SearchProjectionFactory<?,?> factory, ProjectionDefinitionContext context)	Creates a projection with a specific projected type.
static <T> BeanHolder<ConstantProjectionDefinition<List<T>>>	emptyList()
static <T> BeanHolder<ConstantProjectionDefinition<T>>	nullValue()
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.util.common.spi.ToStringTreeAppendable

toStringTree

Method Detail

nullValue

public static <T> BeanHolder<ConstantProjectionDefinition<T>> nullValue()

emptyList

public static <T> BeanHolder<ConstantProjectionDefinition<List<T>>> emptyList()

type

protected String type()

Specified by:

type in class AbstractProjectionDefinition<T>

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<T>

Parameters:

appender - A ToStringTreeAppender.

create

public SearchProjection<T> create(SearchProjectionFactory<?,?> factory,
                                  ProjectionDefinitionContext context)

Description copied from interface: ProjectionDefinition

Creates a projection with a specific projected type.

Parameters:

factory - A projection factory. If the projection is used in the context of an object field, this factory expects field paths to be provided relative to that same object field. This factory is only valid in the present context and must not be used after ProjectionDefinition.create(SearchProjectionFactory, ProjectionDefinitionContext) returns.

context - The context in which the definition is applied.

Returns:

The created SearchPredicate.

See Also:

SearchPredicateFactory, ProjectionDefinitionContext