Package org.hibernate.search.engine.backend.types.dsl

Interface IndexFieldTypeFactoryExtension<T>

Type Parameters:

T - The type of extended index field type factories. Should generally extend IndexFieldTypeFactory.

All Known Implementing Classes:

ElasticsearchExtension, LuceneExtension

public interface IndexFieldTypeFactoryExtension<T>

An extension to the index field type DSL, allowing to create non-standard types in an index schema.

WARNING: while this type is API, because instances should be manipulated by users, all of its methods are considered SPIs and therefore should never be called or implemented directly by users. In short, users are only expected to get instances of this type from an API (SomeExtension.get()) and pass it to another API.

See Also:

• IndexFieldTypeFactory.extension(IndexFieldTypeFactoryExtension)

Method Summary

Modifier and Type	Method	Description
T	extendOrFail(IndexFieldTypeFactory original)	Attempt to extend a given factory, throwing an exception in case of failure.

Method Details

extendOrFail

T extendOrFail(IndexFieldTypeFactory original)

Attempt to extend a given factory, throwing an exception in case of failure.

WARNING: this method is not API, see comments at the type level.

Parameters:

original - The original, non-extended IndexFieldTypeFactory.

Returns:

An extended index field type factory (IndexFieldTypeFactoryExtension)