Interface ContainerExtractor<C,​V>

  • Type Parameters:
    C - The type of containers this extractor can extract values from.
    V - The type of values extracted by this extractor.

    @Incubating
    public interface ContainerExtractor<C,​V>
    An extractor of values from a container.

    Container extractors tell Hibernate Search how to extract values from object properties: no extractor would mean using the property value directly, a collection element extractor would extract each element of a collection, a map keys extractor would extract each key of a map, etc.

    See Also:
    ContainerExtractorPath, BuiltinContainerExtractors
    • Method Detail

      • extract

        Stream<V> extract​(C container)
        Parameters:
        container - A container to extract values from.
        Returns:
        A stream of values extracted from the given container. The stream will be BaseStream.close() by the caller.
      • multiValued

        default boolean multiValued()
        Returns:
        true if this extractor's extract(Object) method may return streams with more than one value. false if it will never return streams with more than one value.