io.servicetalk.http.api

Class StrategyInfluencerChainBuilder

java.lang.Object

io.servicetalk.http.api.StrategyInfluencerChainBuilder

public final class StrategyInfluencerChainBuilder
extends java.lang.Object

A chain of HttpExecutionStrategyInfluencer.

Constructor Summary

Constructors

Constructor and Description
StrategyInfluencerChainBuilder() Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	append(HttpExecutionStrategyInfluencer next) Append another HttpExecutionStrategyInfluencer to this chain.
boolean	appendIfInfluencer(java.lang.Object mayBeInfluencer) If the passed mayBeInfluencer is an HttpExecutionStrategyInfluencer then add it to this chain.
HttpExecutionStrategyInfluencer	build() Builds this chain and returns the head HttpExecutionStrategyInfluencer for the chain.
HttpExecutionStrategyInfluencer	build(HttpExecutionStrategy transportStrategy) Builds this chain and returns the head HttpExecutionStrategyInfluencer for the chain.
StrategyInfluencerChainBuilder	copy() Creates a deep copy of this StrategyInfluencerChainBuilder.
void	prepend(HttpExecutionStrategyInfluencer influencer) Adds the passed HttpExecutionStrategyInfluencer to the head of this chain.
boolean	prependIfInfluencer(java.lang.Object mayBeInfluencer) If the passed mayBeInfluencer is an HttpExecutionStrategyInfluencer then add it to the head of this chain.

Methods inherited from class java.lang.Object

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

Constructor Detail

StrategyInfluencerChainBuilder

public StrategyInfluencerChainBuilder()

Creates a new instance.

Method Detail

prepend

public void prepend(HttpExecutionStrategyInfluencer influencer)

Adds the passed HttpExecutionStrategyInfluencer to the head of this chain.

Parameters:

influencer - HttpExecutionStrategyInfluencer to add.

Throws:

java.lang.IndexOutOfBoundsException - If the passed index is invalid.

prependIfInfluencer

public boolean prependIfInfluencer(java.lang.Object mayBeInfluencer)

If the passed mayBeInfluencer is an HttpExecutionStrategyInfluencer then add it to the head of this chain.

Parameters:

mayBeInfluencer - An object which may be an HttpExecutionStrategyInfluencer.

Returns:

true if the passed mayBeInfluencer was added to the chain.

Throws:

java.lang.IndexOutOfBoundsException - If the passed index is invalid.

append

public void append(HttpExecutionStrategyInfluencer next)

Append another HttpExecutionStrategyInfluencer to this chain.

Parameters:

next - HttpExecutionStrategyInfluencer to append.

appendIfInfluencer

public boolean appendIfInfluencer(java.lang.Object mayBeInfluencer)

If the passed mayBeInfluencer is an HttpExecutionStrategyInfluencer then add it to this chain.

Parameters:

mayBeInfluencer - An object which may be an HttpExecutionStrategyInfluencer.

Returns:

true if the passed mayBeInfluencer was added to the chain.

copy

public StrategyInfluencerChainBuilder copy()

Creates a deep copy of this StrategyInfluencerChainBuilder.

Returns:

A new StrategyInfluencerChainBuilder containing all the influencers added to this StrategyInfluencerChainBuilder.

build

public HttpExecutionStrategyInfluencer build(HttpExecutionStrategy transportStrategy)

Builds this chain and returns the head HttpExecutionStrategyInfluencer for the chain. Invoking HttpExecutionStrategyInfluencer.influenceStrategy(HttpExecutionStrategy) on the returned HttpExecutionStrategyInfluencer will invoke the method on the entire chain before returning.

Parameters:

transportStrategy - HttpExecutionStrategy for the transport, typically specified by the user in the builders.

Returns:

HttpExecutionStrategyInfluencer which is the head of the influencer chain.

build

public HttpExecutionStrategyInfluencer build()

Builds this chain and returns the head HttpExecutionStrategyInfluencer for the chain. Invoking HttpExecutionStrategyInfluencer.influenceStrategy(HttpExecutionStrategy) on the returned HttpExecutionStrategyInfluencer will invoke the method on the entire chain before returning.

Returns:

HttpExecutionStrategyInfluencer which is the head of the influencer chain.