Class Contexts

java.lang.Object

com.azure.core.util.Contexts

public final class Contexts
extends Object

A utility type that can be used to add and retrieve instances commonly used in Context.

Method Summary

Modifier and Type	Method	Description
static Contexts	empty()	Creates Contexts from empty Context.
Context	getContext()	Returns a version of the Context reflecting mutations.
ProgressReporter	getHttpRequestProgressReporter()	Retrieves request's ProgressReporter from the Context.
Contexts	setHttpRequestProgressReporter(ProgressReporter progressReporter)	Adds request's ProgressReporter instance to the Context.
static Contexts	with(Context context)	Creates Contexts from supplied Context.

Methods inherited from class Object

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

Method Details

empty

public static Contexts empty()

Creates Contexts from empty Context.

Returns:

The Contexts instance.

with

public static Contexts with(Context context)

Creates Contexts from supplied Context.

Parameters:

context - Existing Context. Must not be null.

Returns:

The Contexts instance.

Throws:

NullPointerException - If context is null.

setHttpRequestProgressReporter

public Contexts setHttpRequestProgressReporter(ProgressReporter progressReporter)

Adds request's ProgressReporter instance to the Context.

Parameters:

progressReporter - The ProgressReporter instance.

Returns:

Itself.

getHttpRequestProgressReporter

public ProgressReporter getHttpRequestProgressReporter()

Retrieves request's ProgressReporter from the Context.

Returns:

The ProgressReporter.

getContext

public Context getContext()

Returns a version of the Context reflecting mutations.

Returns:

The version of the Context reflecting mutations.