com.netflix.imflibrary.utils

Class FileDataProvider

java.lang.Object

com.netflix.imflibrary.utils.FileDataProvider

All Implemented Interfaces:

ByteProvider

@NotThreadSafe
public final class FileDataProvider
extends java.lang.Object
implements ByteProvider

This class is an non-thread-safe implementation of ByteProvider. The underlying input sequence of bytes is sourced from a file. While this implementation could be enhanced to make it thread-safe, it is difficult to envision an application scenario where an input stream could be shared meaningfully among multiple callers

Constructor Summary

Constructors

Constructor and Description
FileDataProvider(java.io.File file) Instantiates a new FileDataProvider object

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes(int totalNumBytesToRead) Getter for the raw bytes from the encapsulated resource in this case a file
void	skipBytes(long totalNumBytesToSkip) A method that lets the caller skip bytes in the encapsulated 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

FileDataProvider

public FileDataProvider(java.io.File file)

Instantiates a new FileDataProvider object

Parameters:

file - the input file

Method Detail

getBytes

public byte[] getBytes(int totalNumBytesToRead)
                throws java.io.IOException

Getter for the raw bytes from the encapsulated resource in this case a file

Specified by:

getBytes in interface ByteProvider

Parameters:

totalNumBytesToRead - the total num bytes to read from current position in the file

Returns:

byte[] containing next totalNumBytesToRead

Throws:

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

skipBytes

public void skipBytes(long totalNumBytesToSkip)
               throws java.io.IOException

A method that lets the caller skip bytes in the encapsulated resource in this case a file

Specified by:

skipBytes in interface ByteProvider

Parameters:

totalNumBytesToSkip - the total num bytes to skip from the current position in the file

Throws:

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