com.hazelcast.jet.pipeline

## Class HashJoinBuilder<T0>

- java.lang.Object
- - com.hazelcast.jet.pipeline.GeneralHashJoinBuilder<T0>
  - - com.hazelcast.jet.pipeline.HashJoinBuilder<T0>

- Type Parameters:
    `T0` - the type of the items in the primary stage

      public class HashJoinBuilder<T0>
      extends GeneralHashJoinBuilder<T0>

  Offers a step-by-step fluent API to build a hash-join pipeline stage. To obtain it, call `BatchStage.hashJoinBuilder()` on the primary stage, the one whose data will be enriched from all other stages.

  Collect all the tags returned from `add()` and use them to retrieve the enriching items from `ItemsByTag` you get in the result.

  This object is mainly intended to build a hash-join of the primary stage with three or more contributing stages. For one or two stages, prefer the direct `stage.hashJoin(...)` calls because they offer more static type safety.

  Since:
    3.0

- - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `<R> BatchStage<R>` | `build(BiFunctionEx<T0,ItemsByTag,R> mapToOutputFn)` Builds a new pipeline stage that performs the hash-join operation.

    - ### Methods inherited from class com.hazelcast.jet.pipeline.GeneralHashJoinBuilder

      `add`

    - ### Methods inherited from class java.lang.Object

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

- - ### Method Detail

    - #### build

          public <R> BatchStage<R> build(BiFunctionEx<T0,ItemsByTag,R> mapToOutputFn)

      Builds a new pipeline stage that performs the hash-join operation. Attaches the stage to all the contributing stages.
      Returns:
        the new hash-join pipeline stage

Copyright © 2019. All rights reserved.