Modifier and Type	Class and Description
pack-priv static class	DefaultContextSnapshotFactory.Builder

Modifier and Type	Field and Description
private final Predicate<Object>	captureKeyPredicate
private final boolean	clearMissing
private final ContextRegistry	contextRegistry
private static final DefaultContextSnapshot	emptyContextSnapshot

Access	Constructor and Description
public	DefaultContextSnapshotFactory(ContextRegistry contextRegistry, boolean clearMissing, Predicate<Object> captureKeyPredicate)

Method Summary

Modifier and Type	Method and Description
public ContextSnapshot	captureAll(Object... context objects to extract values from contexts) Implements io.micrometer.context.ContextSnapshotFactory.captureAll. Capture values from `ThreadLocal` and from other context objects using all accessors from a `ContextRegistry` instance.
pack-priv static ContextSnapshot	captureAll(ContextRegistry contextRegistry, Predicate<Object> keyPredicate, boolean clearMissing, Object... contexts)
public ContextSnapshot	captureFrom(Object... the contexts to read values from contexts) Implements io.micrometer.context.ContextSnapshotFactory.captureFrom. Create a `ContextSnapshot` by reading values from the given context objects.
pack-priv static DefaultContextSnapshot	captureFromContext(Predicate<Object> keyPredicate, boolean clearMissing, ContextRegistry contextRegistry, DefaultContextSnapshot snapshot, Object... contexts)
private static DefaultContextSnapshot	captureFromThreadLocals(Predicate<Object> keyPredicate, boolean clearMissing, ContextRegistry contextRegistry)
private static DefaultContextSnapshot	clearingEmptySnapshot(ContextRegistry contextRegistry)
pack-priv static <C> ContextSnapshot.Scope	setAllThreadLocalsFrom(Object sourceContext, ContextRegistry contextRegistry, boolean clearMissing)
public <C> ContextSnapshot.Scope	setThreadLocalsFrom(Object the source context to read values from sourceContext, String... the keys of the values to read. If none provided, all keys are considered. keys) Implements io.micrometer.context.ContextSnapshotFactory.setThreadLocalsFrom. Read the values specified by keys from the given source context, and if found, use them to set `ThreadLocal` values.
pack-priv static <C> ContextSnapshot.Scope	setThreadLocalsFrom(Object sourceContext, ContextRegistry contextRegistry, boolean clearMissing, String... keys)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

captureKeyPredicate	back to summary
private final Predicate<Object> captureKeyPredicate

clearMissing	back to summary
private final boolean clearMissing

contextRegistry	back to summary
private final ContextRegistry contextRegistry

emptyContextSnapshot	back to summary
private static final DefaultContextSnapshot emptyContextSnapshot

DefaultContextSnapshotFactory	back to summary
public DefaultContextSnapshotFactory(ContextRegistry contextRegistry, boolean clearMissing, Predicate<Object> captureKeyPredicate)

Method Detail

captureAll back to summary

captureAll	back to summary
public ContextSnapshot captureAll(Object... contexts) Implements io.micrometer.context.ContextSnapshotFactory.captureAll. Doc from io.micrometer.context.ContextSnapshotFactory.captureAll. Capture values from `ThreadLocal` and from other context objects using all accessors from a `ContextRegistry` instance. Values captured multiple times are overridden in the snapshot by the order of contexts given as arguments. Parameters contexts:Object[] context objects to extract values from Returns:ContextSnapshot a snapshot with saved context values Annotations @Override

public ContextSnapshot captureAll(Object... contexts)

Implements io.micrometer.context.ContextSnapshotFactory.captureAll.

Doc from io.micrometer.context.ContextSnapshotFactory.captureAll.

Capture values from ThreadLocal and from other context objects using all accessors from a ContextRegistry instance.

Values captured multiple times are overridden in the snapshot by the order of contexts given as arguments.

Parameters

contexts:Object[]: context objects to extract values from

Returns:ContextSnapshot

a snapshot with saved context values

Annotations

@Override

captureAll	back to summary
pack-priv static ContextSnapshot captureAll(ContextRegistry contextRegistry, Predicate<Object> keyPredicate, boolean clearMissing, Object... contexts)

captureFrom back to summary

captureFrom	back to summary
public ContextSnapshot captureFrom(Object... contexts) Implements io.micrometer.context.ContextSnapshotFactory.captureFrom. Doc from io.micrometer.context.ContextSnapshotFactory.captureFrom. Create a `ContextSnapshot` by reading values from the given context objects. Values captured multiple times are overridden in the snapshot by the order of contexts given as arguments. Parameters contexts:Object[] the contexts to read values from Returns:ContextSnapshot the created `ContextSnapshot` Annotations @Override

public ContextSnapshot captureFrom(Object... contexts)

Implements io.micrometer.context.ContextSnapshotFactory.captureFrom.

Doc from io.micrometer.context.ContextSnapshotFactory.captureFrom.

Create a ContextSnapshot by reading values from the given context objects.

Values captured multiple times are overridden in the snapshot by the order of contexts given as arguments.

Parameters

contexts:Object[]: the contexts to read values from

Returns:ContextSnapshot

the created ContextSnapshot

Annotations

@Override

captureFromContext	back to summary
pack-priv static DefaultContextSnapshot captureFromContext(Predicate<Object> keyPredicate, boolean clearMissing, ContextRegistry contextRegistry, DefaultContextSnapshot snapshot, Object... contexts) Annotations @SuppressWarnings:unchecked

captureFromThreadLocals	back to summary
private static DefaultContextSnapshot captureFromThreadLocals(Predicate<Object> keyPredicate, boolean clearMissing, ContextRegistry contextRegistry) Annotations @Nullable

clearingEmptySnapshot	back to summary
private static DefaultContextSnapshot clearingEmptySnapshot(ContextRegistry contextRegistry)

setAllThreadLocalsFrom	back to summary
pack-priv static <C> ContextSnapshot.Scope setAllThreadLocalsFrom(Object sourceContext, ContextRegistry contextRegistry, boolean clearMissing) Annotations @SuppressWarnings:unchecked

setThreadLocalsFrom back to summary

setThreadLocalsFrom	back to summary
public <C> ContextSnapshot.Scope setThreadLocalsFrom(Object sourceContext, String... keys) Implements io.micrometer.context.ContextSnapshotFactory.setThreadLocalsFrom. Doc from io.micrometer.context.ContextSnapshotFactory.setThreadLocalsFrom. Read the values specified by keys from the given source context, and if found, use them to set `ThreadLocal` values. If no keys are provided, all keys are used. Essentially, a shortcut that bypasses the need to create of `ContextSnapshot` first via `captureFrom(Object...)`, followed by `ContextSnapshot#setThreadLocals()`. Parameters <C> the type of the target context sourceContext:Object the source context to read values from keys:String[] the keys of the values to read. If none provided, all keys are considered. Returns:ContextSnapshot.Scope an object that can be used to reset `ThreadLocal` values at the end of the context scope, either removing them or restoring their previous values, if any. Annotations @Override

public <C> ContextSnapshot.Scope setThreadLocalsFrom(Object sourceContext, String... keys)

Implements io.micrometer.context.ContextSnapshotFactory.setThreadLocalsFrom.

Doc from io.micrometer.context.ContextSnapshotFactory.setThreadLocalsFrom.

Read the values specified by keys from the given source context, and if found, use them to set ThreadLocal values. If no keys are provided, all keys are used. Essentially, a shortcut that bypasses the need to create of ContextSnapshot first via captureFrom(Object...), followed by ContextSnapshot#setThreadLocals().

Parameters

<C>: the type of the target context
sourceContext:Object: the source context to read values from
keys:String[]: the keys of the values to read. If none provided, all keys are considered.

Returns:ContextSnapshot.Scope

an object that can be used to reset ThreadLocal values at the end of the context scope, either removing them or restoring their previous values, if any.

Annotations

@Override

setThreadLocalsFrom	back to summary
pack-priv static <C> ContextSnapshot.Scope setThreadLocalsFrom(Object sourceContext, ContextRegistry contextRegistry, boolean clearMissing, String... keys) Annotations @SuppressWarnings:unchecked

io.micrometer.context back to summary

pack-priv final Class DefaultContextSnapshotFactory.Builder

Class Inheritance

extends Object
implements Builder

java.lang.Object
io.micrometer.context.DefaultContextSnapshotFactory.Builder

All Implemented Interfaces

io.micrometer.context.ContextSnapshotFactory.Builder

Field Summary

Modifier and Type	Field and Description
private Predicate<Object>	captureKeyPredicate
private boolean	clearMissing
private ContextRegistry	contextRegistry

Constructor Summary

Access	Constructor and Description
public	Builder()

Method Summary

Modifier and Type	Method and Description
public ContextSnapshotFactory	build() Implements io.micrometer.context.ContextSnapshotFactory.Builder.build. Creates a new instance of `ContextSnapshotFactory`.
public ContextSnapshotFactory.Builder	captureKeyPredicate(Predicate<Object> predicate used to select matching keys captureKeyPredicate) Implements io.micrometer.context.ContextSnapshotFactory.Builder.captureKeyPredicate. Instructs the factory to use the given predicate to select matching keys when capturing `ThreadLocal` values
public ContextSnapshotFactory.Builder	clearMissing(boolean if `true`, values not present in the context object or snapshot will be cleared at the start of a scope and later restored shouldClear) Implements io.micrometer.context.ContextSnapshotFactory.Builder.clearMissing. Determines whether to clear existing `ThreadLocal` values at the start of a scope, if there are no corresponding values in the source `ContextSnapshot` or context object.
public ContextSnapshotFactory.Builder	contextRegistry(ContextRegistry the registry to use contextRegistry) Implements io.micrometer.context.ContextSnapshotFactory.Builder.contextRegistry. Configures the `ContextRegistry` to use by the created factory.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

captureKeyPredicate	back to summary
private Predicate<Object> captureKeyPredicate

clearMissing	back to summary
private boolean clearMissing

contextRegistry	back to summary
private ContextRegistry contextRegistry

Constructor Detail

Builder	back to summary
public Builder()

Method Detail

build back to summary

build	back to summary
public ContextSnapshotFactory build() Implements io.micrometer.context.ContextSnapshotFactory.Builder.build. Doc from io.micrometer.context.ContextSnapshotFactory.Builder.build. Creates a new instance of `ContextSnapshotFactory`. Returns:ContextSnapshotFactory an instance configured by the values set on the builder Annotations @Override

public ContextSnapshotFactory build()

Implements io.micrometer.context.ContextSnapshotFactory.Builder.build.

Doc from io.micrometer.context.ContextSnapshotFactory.Builder.build.

Creates a new instance of ContextSnapshotFactory.

Returns:ContextSnapshotFactory

an instance configured by the values set on the builder

Annotations

@Override

captureKeyPredicate back to summary

captureKeyPredicate	back to summary
public ContextSnapshotFactory.Builder captureKeyPredicate(Predicate<Object> captureKeyPredicate) Implements io.micrometer.context.ContextSnapshotFactory.Builder.captureKeyPredicate. Doc from io.micrometer.context.ContextSnapshotFactory.Builder.captureKeyPredicate. Instructs the factory to use the given predicate to select matching keys when capturing `ThreadLocal` values Parameters captureKeyPredicate:Predicate<Object> predicate used to select matching keys Returns:ContextSnapshotFactory.Builder this builder instance Annotations @Override

public ContextSnapshotFactory.Builder captureKeyPredicate(Predicate<Object> captureKeyPredicate)

Implements io.micrometer.context.ContextSnapshotFactory.Builder.captureKeyPredicate.

Doc from io.micrometer.context.ContextSnapshotFactory.Builder.captureKeyPredicate.

Instructs the factory to use the given predicate to select matching keys when capturing ThreadLocal values

Parameters

captureKeyPredicate:Predicate<Object>: predicate used to select matching keys

Returns:ContextSnapshotFactory.Builder

this builder instance

Annotations

@Override

clearMissing back to summary

clearMissing	back to summary
public ContextSnapshotFactory.Builder clearMissing(boolean shouldClear) Implements io.micrometer.context.ContextSnapshotFactory.Builder.clearMissing. Doc from io.micrometer.context.ContextSnapshotFactory.Builder.clearMissing. Determines whether to clear existing `ThreadLocal` values at the start of a scope, if there are no corresponding values in the source `ContextSnapshot` or context object. Parameters shouldClear:boolean if `true`, values not present in the context object or snapshot will be cleared at the start of a scope and later restored Returns:ContextSnapshotFactory.Builder this builder instance Annotations @Override

public ContextSnapshotFactory.Builder clearMissing(boolean shouldClear)

Implements io.micrometer.context.ContextSnapshotFactory.Builder.clearMissing.

Doc from io.micrometer.context.ContextSnapshotFactory.Builder.clearMissing.

Determines whether to clear existing ThreadLocal values at the start of a scope, if there are no corresponding values in the source ContextSnapshot or context object.

Parameters

shouldClear:boolean: if true, values not present in the context object or snapshot will be cleared at the start of a scope and later restored

Returns:ContextSnapshotFactory.Builder

this builder instance

Annotations

@Override

contextRegistry back to summary

contextRegistry	back to summary
public ContextSnapshotFactory.Builder contextRegistry(ContextRegistry contextRegistry) Implements io.micrometer.context.ContextSnapshotFactory.Builder.contextRegistry. Doc from io.micrometer.context.ContextSnapshotFactory.Builder.contextRegistry. Configures the `ContextRegistry` to use by the created factory. Parameters contextRegistry:ContextRegistry the registry to use Returns:ContextSnapshotFactory.Builder this builder instance Annotations @Override

public ContextSnapshotFactory.Builder contextRegistry(ContextRegistry contextRegistry)

Implements io.micrometer.context.ContextSnapshotFactory.Builder.contextRegistry.

Doc from io.micrometer.context.ContextSnapshotFactory.Builder.contextRegistry.

Configures the ContextRegistry to use by the created factory.

Parameters