context-propagation 1.1.0 · io.micrometer.context.ContextAccessor

Method Summary

Modifier and Type	Method and Description
public Class<? extends READ>	readableType() `Class` representing the type of context this accessor is capable of reading values from.
public <T> T	Returns: the value, if present readValue(READ the context to read from; the context type should be `assignable` from the type returned by `readableType()`. sourceContext, Object the key to use to look up the context value key) Read a single value from the source context.
public void	readValues(READ the context to read from; the context type should be `assignable` from the type returned by `readableType()`. When an `ContextAccessor` is used to populate a `ContextSnapshot`, the snapshot implementations are required to filter out `null` mappings, so it is not required to implement special handling in the accessor. sourceContext, Predicate<Object> a predicate to decide which keys to read keyPredicate, Map<Object, Object> a map where to put read values readValues) Read values from a source context into a `Map`.
public Class<? extends WRITE>	writeableType() `Class` representing the type of context this accessor can restore values to.
public WRITE	Returns: a context with the written values writeValues(Map<Object, Object> the values to write to the target context. valuesToWrite, WRITE the context to write to; the context type should be `assignable` from the type returned by `writeableType()`. targetContext) Write values from a `Map` to a target context.

Method Detail

readableType	back to summary
public Class<? extends READ> readableType() `Class` representing the type of context this accessor is capable of reading values from.

readValue back to summary

readValue	back to summary
public <T> T readValue(READ sourceContext, Object key) Read a single value from the source context. Parameters sourceContext:READ the context to read from; the context type should be `assignable` from the type returned by `readableType()`. key:Object the key to use to look up the context value Returns:T the value, if present Annotations @Nullable

public <T> T readValue(READ sourceContext, Object key)

Read a single value from the source context.

Parameters

sourceContext:READ: the context to read from; the context type should be assignable from the type returned by readableType().
key:Object: the key to use to look up the context value

Returns:T

the value, if present

Annotations

@Nullable

readValues back to summary

readValues	back to summary
public void readValues(READ sourceContext, Predicate<Object> keyPredicate, Map<Object, Object> readValues) Read values from a source context into a `Map`. Parameters sourceContext:READ the context to read from; the context type should be `assignable` from the type returned by `readableType()`. When an `ContextAccessor` is used to populate a `ContextSnapshot`, the snapshot implementations are required to filter out `null` mappings, so it is not required to implement special handling in the accessor. keyPredicate:Predicate<Object> a predicate to decide which keys to read readValues:Map<Object, Object> a map where to put read values

public void readValues(READ sourceContext, Predicate<Object> keyPredicate, Map<Object, Object> readValues)

Read values from a source context into a Map.

Parameters

sourceContext:READ

the context to read from; the context type should be assignable from the type returned by readableType().

When an ContextAccessor is used to populate a ContextSnapshot, the snapshot implementations are required to filter out null mappings, so it is not required to implement special handling in the accessor.

keyPredicate:Predicate<Object>

a predicate to decide which keys to read

readValues:Map<Object, Object>

a map where to put read values

writeableType	back to summary
public Class<? extends WRITE> writeableType() `Class` representing the type of context this accessor can restore values to.

writeValues back to summary

writeValues	back to summary
public WRITE writeValues(Map<Object, Object> valuesToWrite, WRITE targetContext) Write values from a `Map` to a target context. Parameters valuesToWrite:Map<Object, Object> the values to write to the target context. targetContext:WRITE the context to write to; the context type should be `assignable` from the type returned by `writeableType()`. Returns:WRITE a context with the written values

public WRITE writeValues(Map<Object, Object> valuesToWrite, WRITE targetContext)

Write values from a Map to a target context.

Parameters

valuesToWrite:Map<Object, Object>: the values to write to the target context.
targetContext:WRITE: the context to write to; the context type should be assignable from the type returned by writeableType().

Returns:WRITE

a context with the written values

public Interface ContextAccessor<READ, WRITE>

Method Summary

Method Detail