public final class FileDataSource extends Object implements DataSource
DataSource
for reading local files.Modifier and Type | Class and Description |
---|---|
static class |
FileDataSource.FileDataSourceException
Thrown when IOException is encountered during local file read operation.
|
DataSource.Factory
Constructor and Description |
---|
FileDataSource() |
FileDataSource(TransferListener<? super FileDataSource> listener) |
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes the source.
|
Uri |
getUri()
When the source is open, returns the
Uri from which data is being read. |
long |
open(DataSpec dataSpec)
Opens the source to read the specified data.
|
int |
read(byte[] buffer,
int offset,
int readLength)
Reads up to
length bytes of data and stores them into buffer , starting at
index offset . |
public FileDataSource()
public FileDataSource(TransferListener<? super FileDataSource> listener)
listener
- An optional listener.public long open(DataSpec dataSpec) throws FileDataSource.FileDataSourceException
DataSource
Note: If an IOException
is thrown, callers must still call DataSource.close()
to ensure
that any partial effects of the invocation are cleaned up.
open
in interface DataSource
dataSpec
- Defines the data to be read.DataSpec.length
equals C.LENGTH_UNSET
) this value
is the resolved length of the request, or C.LENGTH_UNSET
if the length is still
unresolved. For all other requests, the value returned will be equal to the request's
DataSpec.length
.FileDataSource.FileDataSourceException
public int read(byte[] buffer, int offset, int readLength) throws FileDataSource.FileDataSourceException
DataSource
length
bytes of data and stores them into buffer
, starting at
index offset
.
If length
is zero then 0 is returned. Otherwise, if no data is available because the
end of the opened range has been reached, then C.RESULT_END_OF_INPUT
is returned.
Otherwise, the call will block until at least one byte of data has been read and the number of
bytes read is returned.
read
in interface DataSource
buffer
- The buffer into which the read data should be stored.offset
- The start offset into buffer
at which data should be written.readLength
- The maximum number of bytes to read.C.RESULT_END_OF_INPUT
if no data is available
because the end of the opened range has been reached.FileDataSource.FileDataSourceException
public Uri getUri()
DataSource
Uri
from which data is being read. The returned
Uri
will be identical to the one passed DataSource.open(DataSpec)
in the DataSpec
unless redirection has occurred. If redirection has occurred, the Uri
after redirection
is returned.getUri
in interface DataSource
Uri
from which data is being read, or null if the source is not open.public void close() throws FileDataSource.FileDataSourceException
DataSource
Note: This method must be called even if the corresponding call to DataSource.open(DataSpec)
threw an IOException
. See DataSource.open(DataSpec)
for more details.
close
in interface DataSource
FileDataSource.FileDataSourceException