com.netflix.imflibrary.utils

Class FileByteRangeProvider

java.lang.Object

com.netflix.imflibrary.utils.FileByteRangeProvider

All Implemented Interfaces:

ResourceByteRangeProvider

@Immutable
public final class FileByteRangeProvider
extends java.lang.Object
implements ResourceByteRangeProvider

This class is an implementation of ResourceByteRangeProvider - the underlying resource is a file. Unless the underlying file is changed externally, this can be considered to be an immutable implementation

Nested Class Summary

Nested classes/interfaces inherited from interface com.netflix.imflibrary.utils.ResourceByteRangeProvider

ResourceByteRangeProvider.Utilities

Constructor Summary

Constructors

Constructor and Description
FileByteRangeProvider(java.io.File resourceFile) Constructor for a FileByteRangeProvider

Method Summary

Modifier and Type	Method and Description
java.io.File	getByteRange(long rangeStart, java.io.File workingDirectory) A method to obtain bytes in the inclusive range [start, endOfFile] as a file
java.io.File	getByteRange(long rangeStart, long rangeEnd, java.io.File workingDirectory) A method to obtain bytes in the inclusive range [start, end] as a file
byte[]	getByteRangeAsBytes(long rangeStart, long rangeEnd) This method provides a way to obtain a byte range from the resource in-memory.
long	getResourceSize() A method that returns the size in bytes of the underlying resource, in this case a File

Methods inherited from class java.lang.Object

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

Constructor Detail

FileByteRangeProvider

public FileByteRangeProvider(java.io.File resourceFile)

Constructor for a FileByteRangeProvider

Parameters:

resourceFile - whose data will be read by this data provider

Method Detail

getResourceSize

public long getResourceSize()

A method that returns the size in bytes of the underlying resource, in this case a File

Specified by:

getResourceSize in interface ResourceByteRangeProvider

Returns:

the size in bytes of the underlying resource, in this case a File

getByteRange

public java.io.File getByteRange(long rangeStart,
                                 java.io.File workingDirectory)
                          throws java.io.IOException

A method to obtain bytes in the inclusive range [start, endOfFile] as a file

Parameters:

rangeStart - zero indexed inclusive start offset; ranges from 0 through (resourceSize -1) both included

workingDirectory - the working directory where the output file is placed

Returns:

file containing desired byte range from rangeStart through end of file

Throws:

java.io.IOException - - any I/O related error will be exposed through an IOException

getByteRange

public java.io.File getByteRange(long rangeStart,
                                 long rangeEnd,
                                 java.io.File workingDirectory)
                          throws java.io.IOException

A method to obtain bytes in the inclusive range [start, end] as a file

Specified by:

getByteRange in interface ResourceByteRangeProvider

Parameters:

rangeStart - zero indexed inclusive start offset; range from [0, (resourceSize -1)] inclusive

rangeEnd - zero indexed inclusive end offset; range from [0, (resourceSize -1)] inclusive

workingDirectory - the working directory where the output file is placed

Returns:

file containing desired byte range

Throws:

java.io.IOException - - any I/O related error will be exposed through an IOException

getByteRangeAsBytes

public byte[] getByteRangeAsBytes(long rangeStart,
                                  long rangeEnd)
                           throws java.io.IOException

This method provides a way to obtain a byte range from the resource in-memory. A limitation of this method is that the total size of the byte range request is capped at 0x7fffffff (the maximum value possible for type int in java)

Parameters:

rangeStart - zero indexed inclusive start offset; ranges from 0 through (resourceSize -1) both included

rangeEnd - zero indexed inclusive end offset; ranges from 0 through (resourceSize -1) both included

Returns:

byte[] containing desired byte range

Throws:

java.io.IOException - - any I/O related error will be exposed through an IOException