alluxio.client.file.options

Class InStreamOptions

java.lang.Object

alluxio.client.file.options.InStreamOptions

@NotThreadSafe
public final class InStreamOptions
extends Object

Information for reading a file. This is an internal options class which contains information from OpenFileOptions as well as the URIStatus being read. In addition to providing access to the fields, it provides convenience functions for various nested fields and creating Protocol.ReadRequests.

Constructor Summary

Constructors

Constructor and Description
InStreamOptions(URIStatus status) Creates with the default OpenFileOptions.
InStreamOptions(URIStatus status, OpenFileOptions options) Creates based on the arguments provided.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
BlockInfo	getBlockInfo(long blockId)
Protocol.OpenUfsBlockOptions	getOpenUfsBlockOptions(long blockId)
OpenFileOptions	getOptions()
URIStatus	getStatus()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

InStreamOptions

public InStreamOptions(URIStatus status)

Creates with the default OpenFileOptions.

Parameters:

status - the file to create the options for

InStreamOptions

public InStreamOptions(URIStatus status,
                       OpenFileOptions options)

Creates based on the arguments provided.

Parameters:

status - the file to create the options for

options - the OpenFileOptions to use

Method Detail

getOptions

public OpenFileOptions getOptions()

Returns:

the OpenFileOptions associated with the instream

getStatus

public URIStatus getStatus()

Returns:

the URIStatus associated with the instream

getBlockInfo

public BlockInfo getBlockInfo(long blockId)

Parameters:

blockId - id of the block

Returns:

the block info associated with the block id, note that this will be a cached copy and will not fetch the latest info from the master

getOpenUfsBlockOptions

public Protocol.OpenUfsBlockOptions getOpenUfsBlockOptions(long blockId)

Parameters:

blockId - id of the block

Returns:

a Protocol.OpenUfsBlockOptions based on the block id and options

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object