DataSourceContractTest (ExoPlayer library)

java.lang.Object
- com.google.android.exoplayer2.testutil.DataSourceContractTest

```
public abstract class DataSourceContractTest
extends Object
```
A collection of contract tests for DataSource implementations.
All these tests should pass for all implementations - behaviour specific to only a subset of implementations should be tested elsewhere.
Subclasses should only include the logic necessary to construct the DataSource and allow it to successfully read data. They shouldn't include any new @Test methods - implementation-specific tests should be in a separate class.
If one of these tests fails for a particular DataSource implementation, that's a bug in the implementation. The test should be overridden in the subclass and annotated Ignore, with a link to an issue to track fixing the implementation and un-ignoring the test.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class DataSourceContractTest.TestResource
Information about a resource that can be used to test the DataSource instance.

Nested Classes
Modifier and Type	Class	Description
`static class`	`DataSourceContractTest.TestResource`	Information about a resource that can be used to test the `DataSource` instance.

Field Summary

Fields
Modifier and Type Field Description

AdditionalFailureInfo additionalFailureInfo

Fields
Modifier and Type	Field	Description
`AdditionalFailureInfo`	`additionalFailureInfo`

Constructor Summary

Constructors
Constructor Description

DataSourceContractTest()

Constructors
Constructor	Description
`DataSourceContractTest()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract DataSource`	`createDataSource()`	Creates and returns an instance of the `DataSource`.
`void`	`dataSpecWithLength_readExpectedRange()`
`void`	`dataSpecWithPosition_readUntilEnd()`
`void`	`dataSpecWithPositionAndLength_readExpectedRange()`
`protected abstract Uri`	`getNotFoundUri()`	Returns a `Uri` that doesn't resolve.
`protected abstract ImmutableList<DataSourceContractTest.TestResource>`	`getTestResources()`	Returns `DataSourceContractTest.TestResource` instances.
`void`	`gzipFlagDoesntAffectReturnedData()`	`DataSpec.FLAG_ALLOW_GZIP` should either be ignored by `DataSource` implementations, or correctly handled (i.e.
`void`	`resourceNotFound()`
`void`	`unboundedDataSpec_readEverything()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - additionalFailureInfo
```
public final AdditionalFailureInfo additionalFailureInfo
```
- Constructor Detail
  - DataSourceContractTest
```
public DataSourceContractTest()
```
- Method Detail
  - createDataSource
```
protected abstract DataSource createDataSource()
                                        throws Exception
```
    Creates and returns an instance of the DataSource.
    
    Throws:
    
    Exception
  - getTestResources
```
protected abstract ImmutableList<DataSourceContractTest.TestResource> getTestResources()
                                                                                throws Exception
```
    Returns DataSourceContractTest.TestResource instances.
    Each resource will be used to exercise the DataSource instance, allowing different behaviours to be tested.
    If multiple resources are returned, it's recommended to disambiguate them using DataSourceContractTest.TestResource.Builder.setName(String).
    
    Throws:
    
    Exception
  - getNotFoundUri
```
protected abstract Uri getNotFoundUri()
```
    Returns a Uri that doesn't resolve.
    This is used to test how a DataSource handles nonexistent data.
  - unboundedDataSpec_readEverything
```
public void unboundedDataSpec_readEverything()
                                      throws Exception
```
    Throws:
    
    Exception
  - dataSpecWithPosition_readUntilEnd
```
public void dataSpecWithPosition_readUntilEnd()
                                       throws Exception
```
    Throws:
    
    Exception
  - dataSpecWithLength_readExpectedRange
```
public void dataSpecWithLength_readExpectedRange()
                                          throws Exception
```
    Throws:
    
    Exception
  - dataSpecWithPositionAndLength_readExpectedRange
```
public void dataSpecWithPositionAndLength_readExpectedRange()
                                                     throws Exception
```
    Throws:
    
    Exception
  - gzipFlagDoesntAffectReturnedData
```
public void gzipFlagDoesntAffectReturnedData()
                                      throws Exception
```
    DataSpec.FLAG_ALLOW_GZIP should either be ignored by DataSource implementations, or correctly handled (i.e. the data is decompressed before being returned from DataReader.read(byte[], int, int)).
    
    Throws:
    
    Exception
  - resourceNotFound
```
public void resourceNotFound()
                      throws Exception
```
    Throws:
    
    Exception

Class DataSourceContractTest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

additionalFailureInfo

Constructor Detail

DataSourceContractTest

Method Detail

createDataSource

getTestResources

getNotFoundUri

unboundedDataSpec_readEverything

dataSpecWithPosition_readUntilEnd

dataSpecWithLength_readExpectedRange

dataSpecWithPositionAndLength_readExpectedRange

gzipFlagDoesntAffectReturnedData

resourceNotFound