Package org.apache.hadoop.fs.impl

Class FileRangeImpl

java.lang.Object

org.apache.hadoop.fs.impl.FileRangeImpl

All Implemented Interfaces:

FileRange

Direct Known Subclasses:

CombinedFileRange

@Private
public class FileRangeImpl
extends java.lang.Object
implements FileRange

A range of bytes from a file with an optional buffer to read those bytes for zero copy. This shouldn't be created directly via constructor rather factory defined in FileRange#createFileRange should be used.

Constructor Summary

Constructors

Constructor	Description
FileRangeImpl(long offset, int length, java.lang.Object reference)	Create.

Method Summary

Modifier and Type	Method	Description
java.util.concurrent.CompletableFuture<java.nio.ByteBuffer>	getData()	Get the future data for this range.
int	getLength()	Get the length of the range.
long	getOffset()	Get the starting offset of the range.
java.lang.Object	getReference()	Get any reference passed in to the file range constructor.
void	setData(java.util.concurrent.CompletableFuture<java.nio.ByteBuffer> pReader)	Set a future for this range's data.
void	setLength(int length)
void	setOffset(long offset)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileRangeImpl

public FileRangeImpl(long offset,
                     int length,
                     java.lang.Object reference)

Create.

Parameters:

offset - offset in file

length - length of data to read.

reference - nullable reference to store in the range.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getOffset

public long getOffset()

Description copied from interface: FileRange

Get the starting offset of the range.

Specified by:

getOffset in interface FileRange

Returns:

the byte offset of the start

getLength

public int getLength()

Description copied from interface: FileRange

Get the length of the range.

Specified by:

getLength in interface FileRange

Returns:

the number of bytes in the range.

setOffset

public void setOffset(long offset)

setLength

public void setLength(int length)

setData

public void setData(java.util.concurrent.CompletableFuture<java.nio.ByteBuffer> pReader)

Description copied from interface: FileRange

Set a future for this range's data. This method is called by PositionedReadable.readVectored(java.util.List<? extends org.apache.hadoop.fs.FileRange>, java.util.function.IntFunction<java.nio.ByteBuffer>) to store the data for the user to pick up later via FileRange.getData().

Specified by:

setData in interface FileRange

Parameters:

pReader - the future of the ByteBuffer that will have the data

getData

public java.util.concurrent.CompletableFuture<java.nio.ByteBuffer> getData()

Description copied from interface: FileRange

Get the future data for this range.

Specified by:

getData in interface FileRange

Returns:

the future for the ByteBuffer that contains the data

getReference

public java.lang.Object getReference()

Description copied from interface: FileRange

Get any reference passed in to the file range constructor. This is not used by any implementation code; it is to help bind this API to libraries retrieving multiple stripes of data in parallel.

Specified by:

getReference in interface FileRange

Returns:

a reference or null.