DataSourceContractTest.TestResource.Builder

Artifact: androidx.media3:media3-test-utils

View Source

---

Kotlin |Java

public final class DataSourceContractTest.TestResource.Builder

---

Builder for TestResource instances.

Summary

Public constructors
Builder()

Public methods
DataSourceContractTest.TestResource	build()
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setExpectedBytes(byte[] expectedBytes) Sets the expected contents of this resource.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setHttpMethod(@DataSpec.HttpMethod int httpMethod) Sets the HTTP method that should be used for the request for this resource.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setMayResolveToUnknownLength(boolean value) Sets whether open may return LENGTH_UNSET when passed the URI of this resource and a DataSpec with length == C.LENGTH_UNSET.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setName(String name) Sets a human-readable name for this resource which will be shown in test failure messages.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setRequestBody(byte[] requestBody) Sets the body that should be included in a request for this resource.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setRequestHeaders(Map<String, String> requestHeaders) Sets the headers that should be included when making a request for this resource.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setResolvedUri(String uri) Sets the URI where this resource is served from.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setResolvedUri(Uri uri) Sets the URI where this resource is served from.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setResponseHeaders(Map<String, List<String>> responseHeaders) Sets the headers associated with this resource that are expected to be present in getResponseHeaders.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setUnexpectedResponseHeaderKeys(     Set<String> unexpectedResponseHeaderKeys ) Sets the keys that must not be present in getResponseHeaders when reading this resource.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setUri(String uri) Sets the URI where this resource should be requested from.
DataSourceContractTest.TestResource.Builder	@CanIgnoreReturnValue setUri(Uri uri) Sets the URI where this resource should be requested from.

Public constructors

Builder

public Builder()

Public methods

build

public DataSourceContractTest.TestResource build()

setExpectedBytes

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setExpectedBytes(byte[] expectedBytes)

Sets the expected contents of this resource. Defaults to an empty byte array.

setHttpMethod

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setHttpMethod(@DataSpec.HttpMethod int httpMethod)

Sets the HTTP method that should be used for the request for this resource.

Tests will fail if the wrong method is used.

Defaults to HTTP_METHOD_GET.

setMayResolveToUnknownLength

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setMayResolveToUnknownLength(boolean value)

Sets whether open may return LENGTH_UNSET when passed the URI of this resource and a DataSpec with length == C.LENGTH_UNSET.

This may be because the underlying resource doesn't have an end (e.g. a 'live' MP3 file that is constantly appended to) or because the resource supports compression that means the 'true' length cannot be initially determined.

Defaults to false.

setName

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setName(String name)

Sets a human-readable name for this resource which will be shown in test failure messages.

setRequestBody

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setRequestBody(byte[] requestBody)

Sets the body that should be included in a request for this resource.

Tests will fail if a request is made without including this body.

Must only be set if setHttpMethod is HTTP_METHOD_POST or HTTP_METHOD_HEAD.

Defaults to an empty array.

setRequestHeaders

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setRequestHeaders(Map<String, String> requestHeaders)

Sets the headers that should be included when making a request for this resource.

Tests will fail if a request is made without including these headers.

This doesn't have to be an exhaustive list, extra headers included in the request will not cause a failure. Defaults to an empty map.

setResolvedUri

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setResolvedUri(String uri)

Sets the URI where this resource is served from. This only needs to be explicitly set if it's different to setUri. See getResolvedUri.

setResolvedUri

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setResolvedUri(Uri uri)

Sets the URI where this resource is served from. This only needs to be explicitly set if it's different to setUri. See getResolvedUri.

setResponseHeaders

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setResponseHeaders(Map<String, List<String>> responseHeaders)

Sets the headers associated with this resource that are expected to be present in getResponseHeaders.

This doesn't have to be an exhaustive list, extra headers in getResponseHeaders are ignored. Defaults to an empty map.

setUnexpectedResponseHeaderKeys

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setUnexpectedResponseHeaderKeys(
    Set<String> unexpectedResponseHeaderKeys
)

Sets the keys that must not be present in getResponseHeaders when reading this resource. Defaults to an empty set.

setUri

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setUri(String uri)

Sets the URI where this resource should be requested from.

setUri

@CanIgnoreReturnValue
public DataSourceContractTest.TestResource.Builder setUri(Uri uri)

Sets the URI where this resource should be requested from.