Package io.ocfl.core

Class ObjectPaths.ObjectRoot

java.lang.Object

io.ocfl.core.ObjectPaths.ObjectRoot

All Implemented Interfaces:

ObjectPaths.HasInventory

Enclosing class:

ObjectPaths

public static class ObjectPaths.ObjectRoot
extends Object
implements ObjectPaths.HasInventory

Provides methods for navigating an OCFL object root

Method Summary

Modifier and Type	Method	Description
ObjectPaths.VersionRoot	headVersion()
String	headVersionPath()
String	inventoryFile()
String	inventorySidecar()
String	mutableHeadExtensionPath()
String	mutableHeadPath()
String	mutableHeadRevisionsPath()
ObjectPaths.VersionRoot	mutableHeadVersion()
String	objectId()
String	path()
ObjectPaths.VersionRoot	version(VersionNum versionNum)
String	versionPath(VersionNum versionNum)

Methods inherited from class java.lang.Object

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

Method Details

path

public String path()

objectId

public String objectId()

inventoryFile

public String inventoryFile()

Specified by:

inventoryFile in interface ObjectPaths.HasInventory

inventorySidecar

public String inventorySidecar()

Specified by:

inventorySidecar in interface ObjectPaths.HasInventory

versionPath

public String versionPath(VersionNum versionNum)

headVersionPath

public String headVersionPath()

mutableHeadExtensionPath

public String mutableHeadExtensionPath()

mutableHeadPath

public String mutableHeadPath()

mutableHeadRevisionsPath

public String mutableHeadRevisionsPath()

version

public ObjectPaths.VersionRoot version(VersionNum versionNum)

headVersion

public ObjectPaths.VersionRoot headVersion()

mutableHeadVersion

public ObjectPaths.VersionRoot mutableHeadVersion()