hera

Interface Context

All Known Implementing Classes:

ContextConc, EmptyContext

@ApiAudience.Public
 @ApiStability.Unstable
public interface Context

Method Summary

Modifier and Type	Method and Description
ChainIdHash	getChainIdHash() Get chain id hash of a context.
Configuration	getConfiguration() Get a configuration of a context.
java.lang.String	getScope() Get scope of a context.
java.util.Set<Strategy>	getStrategies() Get a strategies of a context.
<StrategyT extends Strategy> StrategyT	getStrategy(java.lang.Class<StrategyT> strategyClass) Get a strategy whose matches type strategyClass from a context.
Context	popScope() Get a context instance without current scope.
Context	withChainIdHash(ChainIdHash chainIdHash) Make a context instance with chainIdHash.
Context	withConfiguration(Configuration configuration) Make a context instance with corresponding configuration.
Context	withKeyValue(java.lang.String key, java.lang.Object value) Make a context instance with corresponding key and a value.
Context	withoutKey(java.lang.String key) Get a context instance without configuration matching key.
<StrategyT extends Strategy> Context	withoutStrategy(java.lang.Class<StrategyT> strategy) Remove strategy from the context.
Context	withScope(java.lang.String scope) Make a context instance with scope.
Context	withStrategies(java.util.Set<Strategy> strategies) Make a context instance with corresponding strategies.
<StrategyT extends Strategy> Context	withStrategy(StrategyT strategy) Make a context instance with corresponding strategy.

Method Detail

withScope

Context withScope(java.lang.String scope)

Make a context instance with scope.

Parameters:

scope - a scope

Returns:

a context instance with scope

getScope

java.lang.String getScope()

Get scope of a context.

Returns:

a scope

popScope

Context popScope()

Get a context instance without current scope.

Returns:

a context instance without current scope.

withChainIdHash

Context withChainIdHash(ChainIdHash chainIdHash)

Make a context instance with chainIdHash.

Parameters:

chainIdHash - a chain id hash

Returns:

a context instance with chainIdHash

getChainIdHash

ChainIdHash getChainIdHash()

Get chain id hash of a context. null if not set.

Returns:

a chain id hash

withKeyValue

Context withKeyValue(java.lang.String key,
                     java.lang.Object value)

Make a context instance with corresponding key and a value.

Parameters:

key - a key

value - a value

Returns:

a context instance with a corresponding key-value

withConfiguration

Context withConfiguration(Configuration configuration)

Make a context instance with corresponding configuration.

Parameters:

configuration - a configuration

Returns:

a context instance with a corresponding configuration

getConfiguration

Configuration getConfiguration()

Get a configuration of a context.

Returns:

a configuration

withoutKey

Context withoutKey(java.lang.String key)

Get a context instance without configuration matching key.

Parameters:

key - a key

Returns:

a context instance

withStrategy

<StrategyT extends Strategy> Context withStrategy(StrategyT strategy)

Make a context instance with corresponding strategy.

Type Parameters:

StrategyT - strategy type

Parameters:

strategy - a strategy

Returns:

a context instance with corresponding Strategy

withStrategies

Context withStrategies(java.util.Set<Strategy> strategies)

Make a context instance with corresponding strategies.

Parameters:

strategies - new strategies

Returns:

a context instance with corresponding strategies

getStrategy

<StrategyT extends Strategy> StrategyT getStrategy(java.lang.Class<StrategyT> strategyClass)

Get a strategy whose matches type strategyClass from a context.

Type Parameters:

StrategyT - strategy type

Parameters:

strategyClass - a strategy class

Returns:

a strategy corresponding strategyClass. Otherwise, null

getStrategies

java.util.Set<Strategy> getStrategies()

Get a strategies of a context.

Returns:

a strategies

withoutStrategy

<StrategyT extends Strategy> Context withoutStrategy(java.lang.Class<StrategyT> strategy)

Remove strategy from the context.

Type Parameters:

StrategyT - strategy type

Parameters:

strategy - strategy to remove

Returns:

a context without corresponding Strategy