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

Method Summary

Modifier and Type	Method and Description
public V	getValue() Return the current `ThreadLocal` value.
public Object	key() The key to associate with the ThreadLocal value when saved within a `ContextSnapshot`.
public default void	reset() Deprecated To be replaced by calls to `setValue()` (and/or `restore()`), which needs to be implemented when this implementation is removed. Remove the `ThreadLocal` value when setting `ThreadLocal` values in case of missing mapping for a `key()` from a `ContextSnapshot`, or a Context object (operated upon by `ContextAccessor`).
public default void	restore(V previous value to set, never `null` when called from a `ContextSnapshot` * implementation, which is not allowed to store mappings to `null`. previousValue) Restore the `ThreadLocal` at the end of a `io.`
public default void	restore() Called instead of `restore(Object)` when there was no `ThreadLocal` value existing at the start of the scope.
public void	setValue(V the value to set, never `null` when called from a `ContextSnapshot` implementation, which is not allowed to store mappings to `null`. value) Set the `ThreadLocal` at the start of a `io.`
public default void	setValue() Called instead of `setValue(Object)` in order to remove the current `ThreadLocal` value at the start of a `io.`

getValue back to summary

getValue	back to summary
public V getValue() Return the current `ThreadLocal` value. This method is called in two scenarios: When capturing a `ContextSnapshot`. A `null` value is ignored and the `key()` will not be present in the snapshot. When setting `ThreadLocal` values from a `ContextSnapshot` or from a Context object (through a `ContextAccessor`) to save existing values in order to `restore(Object)` them at the end of the scope. A `null` value means the `ThreadLocal` should not be set and upon closing a `io.micrometer.context.ContextSnapshot.Scope`, the `restore()` variant is called. Annotations @Nullable

public V getValue()

Return the current ThreadLocal value.

This method is called in two scenarios:

When capturing a ContextSnapshot. A null value is ignored and the key() will not be present in the snapshot.
When setting ThreadLocal values from a ContextSnapshot or from a Context object (through a ContextAccessor) to save existing values in order to restore(Object) them at the end of the scope. A null value means the ThreadLocal should not be set and upon closing a io.micrometer.context.ContextSnapshot.Scope, the restore() variant is called.

Annotations

key	back to summary
public Object key() The key to associate with the ThreadLocal value when saved within a `ContextSnapshot`.

reset back to summary

reset	back to summary
public default void reset() Deprecated To be replaced by calls to `setValue()` (and/or `restore()`), which needs to be implemented when this implementation is removed. Remove the `ThreadLocal` value when setting `ThreadLocal` values in case of missing mapping for a `key()` from a `ContextSnapshot`, or a Context object (operated upon by `ContextAccessor`). Annotations @Deprecated

public default void reset()

Deprecated

To be replaced by calls to setValue() (and/or restore()), which needs to be implemented when this implementation is removed.

Remove the ThreadLocal value when setting ThreadLocal values in case of missing mapping for a key() from a ContextSnapshot, or a Context object (operated upon by ContextAccessor).

Annotations

restore back to summary

restore	back to summary
public default void restore(V previousValue) Restore the `ThreadLocal` at the end of a `io.micrometer.context.ContextSnapshot.Scope` to the previous value it had before the start of the scope. Parameters previousValue:V previous value to set, never `null` when called from a `ContextSnapshot` * implementation, which is not allowed to store mappings to `null`. Since 1.0.1

public default void restore(V previousValue)

Restore the ThreadLocal at the end of a io.micrometer.context.ContextSnapshot.Scope to the previous value it had before the start of the scope.

Parameters

previousValue:V: previous value to set, never null when called from a ContextSnapshot * implementation, which is not allowed to store mappings to null.

Since

1.0.1

restore back to summary

restore	back to summary
public default void restore() Called instead of `restore(Object)` when there was no `ThreadLocal` value existing at the start of the scope. Since 1.0.3 See Also `getValue()`

public default void restore()

Called instead of restore(Object) when there was no ThreadLocal value existing at the start of the scope.

setValue back to summary

setValue	back to summary
public void setValue(V value) Set the `ThreadLocal` at the start of a `io.micrometer.context.ContextSnapshot.Scope` to a value obtained from a `ContextSnapshot` or from a different type of context (through a `ContextAccessor`). Parameters value:V the value to set, never `null` when called from a `ContextSnapshot` implementation, which is not allowed to store mappings to `null`.

public void setValue(V value)

Set the ThreadLocal at the start of a io.micrometer.context.ContextSnapshot.Scope to a value obtained from a ContextSnapshot or from a different type of context (through a ContextAccessor).

Parameters

value:V: the value to set, never null when called from a ContextSnapshot implementation, which is not allowed to store mappings to null.

setValue back to summary

setValue	back to summary
public default void setValue() Called instead of `setValue(Object)` in order to remove the current `ThreadLocal` value at the start of a `io.micrometer.context.ContextSnapshot.Scope`. Since 1.0.3

public default void setValue()