DoFnInvoker (core 2.23.0 API)

```
@Internal
public interface DoFnInvoker<InputT,OutputT>
```
Interface for invoking the DoFn processing methods.
Instantiating a DoFnInvoker associates it with a specific DoFn instance, referred to as the bound DoFn.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`DoFnInvoker.ArgumentProvider<InputT,OutputT>` Interface for runner implementors to provide implementations of extra context information.
`static class`	`DoFnInvoker.BaseArgumentProvider<InputT,OutputT>` This `DoFnInvoker.ArgumentProvider` throws `UnsupportedOperationException` for all parameters.
`static class`	`DoFnInvoker.DelegatingArgumentProvider<InputT,OutputT>` An `DoFnInvoker.ArgumentProvider` that forwards all calls to the supplied `delegate`.
`static class`	`DoFnInvoker.FakeArgumentProvider<InputT,OutputT>` A fake `DoFnInvoker.ArgumentProvider` used during testing.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DoFn<InputT,OutputT>`	`getFn()` Get the bound `DoFn`.
`void`	`invokeFinishBundle(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.FinishBundle` method on the bound `DoFn`.
`<RestrictionT> RestrictionT`	`invokeGetInitialRestriction(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.GetInitialRestriction` method on the bound `DoFn`.
`<WatermarkEstimatorStateT> WatermarkEstimatorStateT`	`invokeGetInitialWatermarkEstimatorState(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.GetInitialWatermarkEstimatorState` method on the bound `DoFn`.
`<RestrictionT> Coder<RestrictionT>`	`invokeGetRestrictionCoder(CoderRegistry coderRegistry)` Invoke the `DoFn.GetRestrictionCoder` method on the bound `DoFn`.
`double`	`invokeGetSize(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.GetSize` method on the bound `DoFn`.
`<WatermarkEstimatorStateT> Coder<WatermarkEstimatorStateT>`	`invokeGetWatermarkEstimatorStateCoder(CoderRegistry coderRegistry)` Invoke the `DoFn.GetWatermarkEstimatorStateCoder` method on the bound `DoFn`.
`<RestrictionT,PositionT> RestrictionTracker<RestrictionT,PositionT>`	`invokeNewTracker(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.NewTracker` method on the bound `DoFn`.
`<WatermarkEstimatorStateT> WatermarkEstimator<WatermarkEstimatorStateT>`	`invokeNewWatermarkEstimator(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.NewWatermarkEstimator` method on the bound `DoFn`.
`void`	`invokeOnTimer(java.lang.String timerId, java.lang.String timerFamilyId, DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the appropriate `DoFn.OnTimer` method on the bound `DoFn`.
`void`	`invokeOnWindowExpiration(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.OnWindowExpiration` method on the bound `DoFn`.
`DoFn.ProcessContinuation`	`invokeProcessElement(DoFnInvoker.ArgumentProvider<InputT,OutputT> extra)` Invoke the `DoFn.ProcessElement` method on the bound `DoFn`.
`void`	`invokeSetup()` Invoke the `DoFn.Setup` method on the bound `DoFn`.
`void`	`invokeSplitRestriction(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.SplitRestriction` method on the bound `DoFn`.
`void`	`invokeStartBundle(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)` Invoke the `DoFn.StartBundle` method on the bound `DoFn`.
`void`	`invokeTeardown()` Invoke the `DoFn.Teardown` method on the bound `DoFn`.

- Method Detail
  - invokeSetup
```
void invokeSetup()
```
    Invoke the DoFn.Setup method on the bound DoFn.
  - invokeStartBundle
```
void invokeStartBundle(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.StartBundle method on the bound DoFn.
  - invokeFinishBundle
```
void invokeFinishBundle(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.FinishBundle method on the bound DoFn.
  - invokeTeardown
```
void invokeTeardown()
```
    Invoke the DoFn.Teardown method on the bound DoFn.
  - invokeOnWindowExpiration
```
void invokeOnWindowExpiration(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.OnWindowExpiration method on the bound DoFn.
  - invokeProcessElement
```
DoFn.ProcessContinuation invokeProcessElement(DoFnInvoker.ArgumentProvider<InputT,OutputT> extra)
```
    Invoke the DoFn.ProcessElement method on the bound DoFn.
    
    Parameters:
    
    extra - Factory for producing extra parameter objects (such as window), if necessary.
    
    Returns:
    
    The DoFn.ProcessContinuation returned by the underlying method, or DoFn.ProcessContinuation#stop() if it returns void.
  - invokeOnTimer
```
void invokeOnTimer(java.lang.String timerId,
                   java.lang.String timerFamilyId,
                   DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the appropriate DoFn.OnTimer method on the bound DoFn.
  - invokeGetInitialRestriction
```
<RestrictionT> RestrictionT invokeGetInitialRestriction(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.GetInitialRestriction method on the bound DoFn.
  - invokeGetRestrictionCoder
```
<RestrictionT> Coder<RestrictionT> invokeGetRestrictionCoder(CoderRegistry coderRegistry)
```
    Invoke the DoFn.GetRestrictionCoder method on the bound DoFn. Called only during pipeline construction time.
  - invokeSplitRestriction
```
void invokeSplitRestriction(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.SplitRestriction method on the bound DoFn.
  - invokeGetSize
```
double invokeGetSize(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.GetSize method on the bound DoFn. Falls back to:
    1. get the work remaining from the RestrictionTracker if it supports RestrictionTracker.HasProgress.
    2. returning the constant 1.0.
  - invokeNewTracker
```
<RestrictionT,PositionT> RestrictionTracker<RestrictionT,PositionT> invokeNewTracker(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.NewTracker method on the bound DoFn.
  - invokeNewWatermarkEstimator
```
<WatermarkEstimatorStateT> WatermarkEstimator<WatermarkEstimatorStateT> invokeNewWatermarkEstimator(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.NewWatermarkEstimator method on the bound DoFn.
  - invokeGetInitialWatermarkEstimatorState
```
<WatermarkEstimatorStateT> WatermarkEstimatorStateT invokeGetInitialWatermarkEstimatorState(DoFnInvoker.ArgumentProvider<InputT,OutputT> arguments)
```
    Invoke the DoFn.GetInitialWatermarkEstimatorState method on the bound DoFn.
  - invokeGetWatermarkEstimatorStateCoder
```
<WatermarkEstimatorStateT> Coder<WatermarkEstimatorStateT> invokeGetWatermarkEstimatorStateCoder(CoderRegistry coderRegistry)
```
    Invoke the DoFn.GetWatermarkEstimatorStateCoder method on the bound DoFn. Called only during pipeline construction time.
  - getFn
```
DoFn<InputT,OutputT> getFn()
```
    Get the bound DoFn.

Interface DoFnInvoker<InputT,OutputT>

Nested Class Summary

Method Summary

Method Detail

invokeSetup

invokeStartBundle

invokeFinishBundle

invokeTeardown

invokeOnWindowExpiration

invokeProcessElement

invokeOnTimer

invokeGetInitialRestriction

invokeGetRestrictionCoder

invokeSplitRestriction

invokeGetSize

invokeNewTracker

invokeNewWatermarkEstimator

invokeGetInitialWatermarkEstimatorState

invokeGetWatermarkEstimatorStateCoder

getFn