Uses of Class
io.ocfl.api.model.ObjectVersionId

Packages that use ObjectVersionId

Package	Description
io.ocfl.api
io.ocfl.api.model

Uses of ObjectVersionId in io.ocfl.api

Methods in io.ocfl.api that return ObjectVersionId

Modifier and Type	Method	Description
ObjectVersionId	MutableOcflRepository.commitStagedChanges(String objectId, VersionInfo versionInfo)	Converts the staged changes in the mutable HEAD into an immutable core OCFL version that can be read by any OCFL client.
ObjectVersionId	OcflRepository.putObject(ObjectVersionId objectVersionId, Path path, VersionInfo versionInfo, OcflOption... options)	Adds the object rooted at the given path to the OCFL repository under the given objectVersionId.
ObjectVersionId	OcflRepository.replicateVersionAsHead(ObjectVersionId objectVersionId, VersionInfo versionInfo)	Creates a new head version by copying the state of the specified version.
ObjectVersionId	MutableOcflRepository.stageChanges(ObjectVersionId objectId, VersionInfo versionInfo, Consumer<OcflObjectUpdater> objectUpdater)	Stages changes to the mutable HEAD of the specified object.
ObjectVersionId	OcflRepository.updateObject(ObjectVersionId objectVersionId, VersionInfo versionInfo, Consumer<OcflObjectUpdater> objectUpdater)	Updates an existing object OR create a new object by selectively adding, removing, moving files within the object, and creating a new version that encapsulates all of the changes.

Methods in io.ocfl.api with parameters of type ObjectVersionId

Modifier and Type	Method	Description
VersionDetails	OcflRepository.describeVersion(ObjectVersionId objectVersionId)	Returns the details about a specific version of an object.
void	OcflRepository.exportVersion(ObjectVersionId objectVersionId, Path outputPath, OcflOption... options)	Copies a raw OCFL object version to the specified directory.
OcflObjectVersion	OcflRepository.getObject(ObjectVersionId objectVersionId)	Returns the details about a specific version of an object along with lazy-loading handles to all of the files in the object.
void	OcflRepository.getObject(ObjectVersionId objectVersionId, Path outputPath)	Returns the entire contents of the object at the specified version.
ObjectVersionId	OcflRepository.putObject(ObjectVersionId objectVersionId, Path path, VersionInfo versionInfo, OcflOption... options)	Adds the object rooted at the given path to the OCFL repository under the given objectVersionId.
ObjectVersionId	OcflRepository.replicateVersionAsHead(ObjectVersionId objectVersionId, VersionInfo versionInfo)	Creates a new head version by copying the state of the specified version.
void	OcflRepository.rollbackToVersion(ObjectVersionId objectVersionId)	Rolls an object back to the specified version.
ObjectVersionId	MutableOcflRepository.stageChanges(ObjectVersionId objectId, VersionInfo versionInfo, Consumer<OcflObjectUpdater> objectUpdater)	Stages changes to the mutable HEAD of the specified object.
ObjectVersionId	OcflRepository.updateObject(ObjectVersionId objectVersionId, VersionInfo versionInfo, Consumer<OcflObjectUpdater> objectUpdater)	Updates an existing object OR create a new object by selectively adding, removing, moving files within the object, and creating a new version that encapsulates all of the changes.

Uses of ObjectVersionId in io.ocfl.api.model

Methods in io.ocfl.api.model that return ObjectVersionId

Modifier and Type	Method	Description
ObjectVersionId	FileChange.getObjectVersionId()	The ObjectVersionId for the version the changed occurred in
ObjectVersionId	OcflObjectVersion.getObjectVersionId()	The ObjectId of the version
ObjectVersionId	VersionDetails.getObjectVersionId()	The ObjectVersionId of the version
static ObjectVersionId	ObjectVersionId.head(String objectId)	Creates an ObjectId instance that points to the HEAD version of the object
ObjectVersionId	ObjectVersionId.nextVersion()	Returns a new ObjectVersionId instance with an incremented version number.
ObjectVersionId	ObjectVersionId.previousVersion()	Returns a new ObjectVersionId instance with an decremented version number.
static ObjectVersionId	ObjectVersionId.version(String objectId, int versionNum)	Creates an ObjectId instance that points to a specific version of an object
static ObjectVersionId	ObjectVersionId.version(String objectId, VersionNum versionNum)	Creates an ObjectId instance that points to a specific version of an object
static ObjectVersionId	ObjectVersionId.version(String objectId, String versionNum)	Creates an ObjectId instance that points to a specific version of an object

Methods in io.ocfl.api.model with parameters of type ObjectVersionId

Modifier and Type	Method	Description
FileChange	FileChange.setObjectVersionId(ObjectVersionId objectVersionId)
VersionDetails	VersionDetails.setObjectVersionId(ObjectVersionId objectVersionId)