## Uses of Interface
com.hazelcast.jet.core.ProcessorSupplier

- Packages that use ProcessorSupplier
  Package | Description
  --- | ---
  com.hazelcast.jet.core | Jet's Core API.
  com.hazelcast.jet.core.processor | Contains static utility classes with factories of Jet processors.
  com.hazelcast.jet.core.test | Utilities for writing tests of Core API Processors.
  com.hazelcast.jet.pipeline | The Pipeline API is Jet's high-level API to build and execute distributed computation jobs.

- - ### Uses of ProcessorSupplier in com.hazelcast.jet.core

    Methods in com.hazelcast.jet.core that return ProcessorSupplier
    Modifier and Type | Method and Description
    --- | ---
    `static ProcessorSupplier` | ProcessorSupplier.`of(SupplierEx<? extends Processor> processorSupplier)` Returns a `ProcessorSupplier` which will delegate to the given `Supplier<Processor>` to create all `Processor` instances.

    Methods in com.hazelcast.jet.core that return types with arguments of type ProcessorSupplier
    Modifier and Type | Method and Description
    --- | ---
    `Function<? super Address,? extends ProcessorSupplier>` | ProcessorMetaSupplier.`get(List<Address> addresses)` Called to create a mapping from member `Address` to the `ProcessorSupplier` that will be sent to that member.

    Methods in com.hazelcast.jet.core with parameters of type ProcessorSupplier
    Modifier and Type | Method and Description
    --- | ---
    `static ProcessorMetaSupplier` | ProcessorMetaSupplier.`forceTotalParallelismOne(ProcessorSupplier supplier)` Variant of `ProcessorMetaSupplier.forceTotalParallelismOne(ProcessorSupplier, String)` where the node for the supplier will be chosen randomly.
    `static ProcessorMetaSupplier` | ProcessorMetaSupplier.`forceTotalParallelismOne(ProcessorSupplier supplier, String partitionKey)` Wraps the provided `ProcessorSupplier` into a meta-supplier that will only use the given `ProcessorSupplier` on a single node.
    `Vertex` | DAG.`newVertex(String name, ProcessorSupplier processorSupplier)` Creates a vertex from a `ProcessorSupplier` and adds it to this DAG.
    `static ProcessorMetaSupplier` | ProcessorMetaSupplier.`of(int preferredLocalParallelism, ProcessorSupplier procSupplier)` Factory method that wraps the given `ProcessorSupplier` and returns the same instance for each given `Address`.
    `static ProcessorMetaSupplier` | ProcessorMetaSupplier.`of(ProcessorSupplier procSupplier)` Wraps the provided `ProcessorSupplier` into a meta-supplier that will always return it.
    `static ProcessorMetaSupplier` | ProcessorMetaSupplier.`preferLocalParallelismOne(ProcessorSupplier supplier)` Wraps the provided `ProcessorSupplier` into a meta-supplier that will always return it.

    Method parameters in com.hazelcast.jet.core with type arguments of type ProcessorSupplier
    Modifier and Type | Method and Description
    --- | ---
    `static ProcessorMetaSupplier` | ProcessorMetaSupplier.`of(FunctionEx<? super Address,? extends ProcessorSupplier> addressToSupplier)` Factory method that creates a `ProcessorMetaSupplier` from the supplied function that maps a cluster member address to a `ProcessorSupplier`.
    `static ProcessorMetaSupplier` | ProcessorMetaSupplier.`of(FunctionEx<? super Address,? extends ProcessorSupplier> addressToSupplier, int preferredLocalParallelism)` Factory method that creates a `ProcessorMetaSupplier` from the supplied function that maps a cluster member address to a `ProcessorSupplier`.

    Constructors in com.hazelcast.jet.core with parameters of type ProcessorSupplier
    Constructor and Description
    `Vertex(String name, ProcessorSupplier processorSupplier)` Creates a vertex from a `ProcessorSupplier`.

  - ### Uses of ProcessorSupplier in com.hazelcast.jet.core.processor

    Methods in com.hazelcast.jet.core.processor that return ProcessorSupplier
    Modifier and Type | Method and Description
    --- | ---
    `static <C,T,K> ProcessorSupplier` | Processors.`filterUsingContextAsyncP(ContextFactory<C> contextFactory, FunctionEx<T,K> extractKeyFn, BiFunctionEx<? super C,? super T,CompletableFuture<Boolean>> filterAsyncFn)` Asynchronous version of `Processors.filterUsingContextP(com.hazelcast.jet.pipeline.ContextFactory<C>, com.hazelcast.jet.function.BiPredicateEx<? super C, ? super T>)`: the `filterAsyncFn` returns a `CompletableFuture<Boolean>` instead of just a `boolean`.
    `static <C,T> ProcessorSupplier` | Processors.`filterUsingContextP(ContextFactory<C> contextFactory, BiPredicateEx<? super C,? super T> filterFn)` Returns a supplier of processors for a vertex that emits the same items it receives, but only those that pass the given predicate.
    `static <C,T,K,R> ProcessorSupplier` | Processors.`flatMapUsingContextAsyncP(ContextFactory<C> contextFactory, FunctionEx<? super T,? extends K> extractKeyFn, BiFunctionEx<? super C,? super T,CompletableFuture<Traverser<R>>> flatMapAsyncFn)` Asynchronous version of `Processors.flatMapUsingContextP(com.hazelcast.jet.pipeline.ContextFactory<C>, com.hazelcast.jet.function.BiFunctionEx<? super C, ? super T, ? extends com.hazelcast.jet.Traverser<? extends R>>)`: the `flatMapAsyncFn` returns a `CompletableFuture<Traverser<R>>` instead of just a `Traverser<R>`.
    `static <C,T,R> ProcessorSupplier` | Processors.`flatMapUsingContextP(ContextFactory<C> contextFactory, BiFunctionEx<? super C,? super T,? extends Traverser<? extends R>> flatMapFn)` Returns a supplier of processors for a vertex that applies the provided item-to-traverser mapping function to each received item and emits all the items from the resulting traverser.
    `static <C,T,K,R> ProcessorSupplier` | Processors.`mapUsingContextAsyncP(ContextFactory<C> contextFactory, FunctionEx<T,K> extractKeyFn, BiFunctionEx<? super C,? super T,CompletableFuture<R>> mapAsyncFn)` Asynchronous version of `Processors.mapUsingContextP(com.hazelcast.jet.pipeline.ContextFactory<C>, com.hazelcast.jet.function.BiFunctionEx<? super C, ? super T, ? extends R>)`: the `mapAsyncFn` returns a `CompletableFuture<R>` instead of just `R`.
    `static <C,T,R> ProcessorSupplier` | Processors.`mapUsingContextP(ContextFactory<C> contextFactory, BiFunctionEx<? super C,? super T,? extends R> mapFn)` Returns a supplier of processors for a vertex which, for each received item, emits the result of applying the given mapping function to it.
    `static <T> ProcessorSupplier` | DiagnosticProcessors.`peekInputP(FunctionEx<T,? extends CharSequence> toStringFn, PredicateEx<T> shouldLogFn, ProcessorSupplier wrapped)` Same as `peekInput(toStringFn, shouldLogFn, metaSupplier)`, but accepts a `ProcessorSupplier` instead of a meta-supplier.
    `static ProcessorSupplier` | DiagnosticProcessors.`peekInputP(ProcessorSupplier wrapped)` Convenience for `peekInput(toStringFn, shouldLogFn, metaSupplier)` with a pass-through filter and `Object#toString` as the formatting function.
    `static <T> ProcessorSupplier` | DiagnosticProcessors.`peekOutputP(FunctionEx<? super T,? extends CharSequence> toStringFn, PredicateEx<? super T> shouldLogFn, ProcessorSupplier wrapped)` Same as `peekOutput(toStringFn, shouldLogFn, metaSupplier)`, but accepts a `ProcessorSupplier` instead of a meta-supplier.
    `static ProcessorSupplier` | DiagnosticProcessors.`peekOutputP(ProcessorSupplier wrapped)` Convenience for `peekOutput(toStringFn, shouldLogFn, metaSupplier` with a pass-through filter and `Object#toString` as the formatting function.
    `static <K,V> ProcessorSupplier` | DiagnosticProcessors.`peekSnapshotP(FunctionEx<? super Map.Entry<K,V>,? extends CharSequence> toStringFn, PredicateEx<? super Map.Entry<K,V>> shouldLogFn, ProcessorSupplier wrapped)` Same as `peekSnapshot(toStringFn, shouldLogFn, metaSupplier)`, but accepts a `ProcessorSupplier` instead of a meta-supplier.
    `static ProcessorSupplier` | DiagnosticProcessors.`peekSnapshotP(ProcessorSupplier wrapped)` Convenience for `peekSnapshot(toStringFn, shouldLogFn, metaSupplier` with a pass-through filter and `Object#toString` as the formatting function.
    `static ProcessorSupplier` | SourceProcessors.`readRemoteCacheP(String cacheName, ClientConfig clientConfig)` Returns a supplier of processors for `Sources.remoteCache(String, ClientConfig)`.
    `static ProcessorSupplier` | SourceProcessors.`readRemoteMapP(String mapName, ClientConfig clientConfig)` Returns a supplier of processors for `Sources.remoteMap(String, ClientConfig)`.
    `static <T,K,V> ProcessorSupplier` | SourceProcessors.`readRemoteMapP(String mapName, ClientConfig clientConfig, Predicate<? super K,? super V> predicate, FunctionEx<? super Map.Entry<K,V>,? extends T> projectionFn)` Returns a supplier of processors for `Sources.remoteMap(String, ClientConfig, Predicate, FunctionEx)`.
    `static <T,K,V> ProcessorSupplier` | SourceProcessors.`readRemoteMapP(String mapName, ClientConfig clientConfig, Predicate<? super K,? super V> predicate, Projection<? super Map.Entry<K,V>,? extends T> projection)` Returns a supplier of processors for `Sources.remoteMap(String, ClientConfig, Predicate, Projection)`.

    Methods in com.hazelcast.jet.core.processor with parameters of type ProcessorSupplier
    Modifier and Type | Method and Description
    --- | ---
    `static <T> ProcessorSupplier` | DiagnosticProcessors.`peekInputP(FunctionEx<T,? extends CharSequence> toStringFn, PredicateEx<T> shouldLogFn, ProcessorSupplier wrapped)` Same as `peekInput(toStringFn, shouldLogFn, metaSupplier)`, but accepts a `ProcessorSupplier` instead of a meta-supplier.
    `static ProcessorSupplier` | DiagnosticProcessors.`peekInputP(ProcessorSupplier wrapped)` Convenience for `peekInput(toStringFn, shouldLogFn, metaSupplier)` with a pass-through filter and `Object#toString` as the formatting function.
    `static <T> ProcessorSupplier` | DiagnosticProcessors.`peekOutputP(FunctionEx<? super T,? extends CharSequence> toStringFn, PredicateEx<? super T> shouldLogFn, ProcessorSupplier wrapped)` Same as `peekOutput(toStringFn, shouldLogFn, metaSupplier)`, but accepts a `ProcessorSupplier` instead of a meta-supplier.
    `static ProcessorSupplier` | DiagnosticProcessors.`peekOutputP(ProcessorSupplier wrapped)` Convenience for `peekOutput(toStringFn, shouldLogFn, metaSupplier` with a pass-through filter and `Object#toString` as the formatting function.
    `static <K,V> ProcessorSupplier` | DiagnosticProcessors.`peekSnapshotP(FunctionEx<? super Map.Entry<K,V>,? extends CharSequence> toStringFn, PredicateEx<? super Map.Entry<K,V>> shouldLogFn, ProcessorSupplier wrapped)` Same as `peekSnapshot(toStringFn, shouldLogFn, metaSupplier)`, but accepts a `ProcessorSupplier` instead of a meta-supplier.
    `static ProcessorSupplier` | DiagnosticProcessors.`peekSnapshotP(ProcessorSupplier wrapped)` Convenience for `peekSnapshot(toStringFn, shouldLogFn, metaSupplier` with a pass-through filter and `Object#toString` as the formatting function.

  - ### Uses of ProcessorSupplier in com.hazelcast.jet.core.test

    Methods in com.hazelcast.jet.core.test with parameters of type ProcessorSupplier
    Modifier and Type | Method and Description
    --- | ---
    `static Supplier<Processor>` | TestSupport.`supplierFrom(ProcessorSupplier supplier)` Wraps the provided `ProcessorSupplier` with a `Supplier<Processor>` that returns processors obtained from it.
    `static Supplier<Processor>` | TestSupport.`supplierFrom(ProcessorSupplier supplier, ProcessorSupplier.Context context)` Wraps the provided `ProcessorSupplier` with a `Supplier<Processor>` that returns processors obtained from it.
    `static TestSupport` | TestSupport.`verifyProcessor(ProcessorSupplier supplier)`

  - ### Uses of ProcessorSupplier in com.hazelcast.jet.pipeline

    Methods in com.hazelcast.jet.pipeline with parameters of type ProcessorSupplier
    Modifier and Type | Method and Description
    --- | ---
    `default <R> StreamStage<R>` | StreamStageWithKey.`customTransform(String stageName, ProcessorSupplier procSupplier)`
    `default <R> StreamStage<R>` | StreamStage.`customTransform(String stageName, ProcessorSupplier procSupplier)`
    `<R> GeneralStage<R>` | GeneralStageWithKey.`customTransform(String stageName, ProcessorSupplier procSupplier)` Attaches a stage with a custom transform based on the provided supplier of Core API `Processor`s.
    `<R> GeneralStage<R>` | GeneralStage.`customTransform(String stageName, ProcessorSupplier procSupplier)` Attaches a stage with a custom transform based on the provided supplier of Core API `Processor`s.
    `default <R> BatchStage<R>` | BatchStageWithKey.`customTransform(String stageName, ProcessorSupplier procSupplier)`
    `default <R> BatchStage<R>` | BatchStage.`customTransform(String stageName, ProcessorSupplier procSupplier)`

Copyright © 2019. All rights reserved.