Package com.yahoo.vespa.filedistribution

Class FileReferenceData

java.lang.Object

com.yahoo.vespa.filedistribution.FileReferenceData

Direct Known Subclasses:

EmptyFileReferenceData, LazyFileReferenceData

public abstract class FileReferenceData
extends Object

Utility class for a file reference with data and metadata

Author:

hmusum

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FileReferenceData.CompressionType
static enum	FileReferenceData.Type

Constructor Summary

Constructors

Constructor	Description
FileReferenceData(com.yahoo.config.FileReference fileReference, String filename, FileReferenceData.Type type, FileReferenceData.CompressionType compressionType)

Method Summary

Modifier and Type	Method	Description
abstract void	close()	Close underlying files
FileReferenceData.CompressionType	compressionType()
ByteBuffer	content()
String	filename()
com.yahoo.config.FileReference	fileReference()
abstract int	nextContent(ByteBuffer bb)	Will provide the next part of the content.
abstract long	size()	The size of the content in bytes
String	toString()
FileReferenceData.Type	type()
abstract long	xxhash()	Only guaranteed to be valid after all content has been consumed.

Methods inherited from class java.lang.Object

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

Constructor Details

FileReferenceData

public FileReferenceData(com.yahoo.config.FileReference fileReference,
 String filename,
 FileReferenceData.Type type,
 FileReferenceData.CompressionType compressionType)

Method Details

fileReference

public com.yahoo.config.FileReference fileReference()

filename

public String filename()

type

public FileReferenceData.Type type()

compressionType

public FileReferenceData.CompressionType compressionType()

content

public ByteBuffer content()

nextContent

public abstract int nextContent(ByteBuffer bb)

Will provide the next part of the content.

Parameters:

bb - with some available space

Returns:

Number of bytes transferred.

xxhash

public abstract long xxhash()

Only guaranteed to be valid after all content has been consumed.

Returns:

xxhash64 of content

size

public abstract long size()

The size of the content in bytes

Returns:

number of bytes

close

public abstract void close()

Close underlying files

toString

public String toString()

Overrides:

toString in class Object