Package io.ocfl.api.model

Class OcflObjectVersionFile

java.lang.Object

io.ocfl.api.model.OcflObjectVersionFile

public class OcflObjectVersionFile
extends Object

Represents a file within an OCFL object at a specific version. The file content can be lazy-loaded.

Constructor Summary

Constructors

Constructor	Description
OcflObjectVersionFile(FileDetails fileDetails, OcflFileRetriever fileRetriever)

Method Summary

Modifier and Type	Method	Description
Map<DigestAlgorithm,String>	getFixity()	Map of digest algorithm to digest value.
String	getPath()	The file's logical path within the object
InputStream	getRange(Long startPosition, Long endPosition)	Returns an input stream of the file's content between the specified byte range.
String	getStorageRelativePath()	The file's path relative to the storage root
FixityCheckInputStream	getStream()	Returns a new input stream of the file's content.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

OcflObjectVersionFile

public OcflObjectVersionFile(FileDetails fileDetails,
 OcflFileRetriever fileRetriever)

Method Details

getPath

public String getPath()

The file's logical path within the object

Returns:

logical path

getStorageRelativePath

public String getStorageRelativePath()

The file's path relative to the storage root

Returns:

storage relative path

getFixity

public Map<DigestAlgorithm,String> getFixity()

Map of digest algorithm to digest value.

Returns:

digest map

getStream

public FixityCheckInputStream getStream()

Returns a new input stream of the file's content. The caller is responsible for closing the stream.

The caller may call checkFixity() on the InputStream after streaming all of that data to ensure the fixity of data.

Returns:

FixityCheckInputStream of the file's content

getRange

public InputStream getRange(Long startPosition,
 Long endPosition)

Returns an input stream of the file's content between the specified byte range. startPosition and endPosition may be null, depending on the underlying implementation, and the meaning of a null value is also implementation dependent.

The caller is responsible for closing the stream. The input stream is buffered.

Parameters:

startPosition - the byte offset in the file to start reading, inclusive

endPosition - the byte offset in the file to stop reading, inclusive

Returns:

a buffered input stream containing the specified file data

toString

public String toString()

Overrides:

toString in class Object