Package edu.wisc.library.ocfl.api.model

Class ObjectDetails

java.lang.Object

edu.wisc.library.ocfl.api.model.ObjectDetails

public class ObjectDetails
extends Object

Details the current state of an object and all of its versions.

Constructor Summary

Constructors

Constructor	Description
ObjectDetails()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
DigestAlgorithm	getDigestAlgorithm()
VersionDetails	getHeadVersion()	The version details of the HEAD version of the object
VersionNum	getHeadVersionNum()	The version number of the HEAD version of the object
String	getId()
VersionDetails	getVersion(VersionNum versionNum)	Returns the VersionDetails for the specified version number or null if the version does not exist
Map<VersionNum,VersionDetails>	getVersionMap()	Map of version number to version details for all of the versions of the object.
int	hashCode()
ObjectDetails	setDigestAlgorithm(DigestAlgorithm digestAlgorithm)
ObjectDetails	setHeadVersionNum(VersionNum headVersionNum)
ObjectDetails	setId(String id)
ObjectDetails	setVersions(Map<VersionNum,VersionDetails> versions)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectDetails

public ObjectDetails()

Method Detail

getHeadVersion

public VersionDetails getHeadVersion()

The version details of the HEAD version of the object

Returns:

VersionDetails for the object's HEAD version

getId

public String getId()

Returns:

the object's id

setId

public ObjectDetails setId(String id)

getHeadVersionNum

public VersionNum getHeadVersionNum()

The version number of the HEAD version of the object

Returns:

the version number of the object's HEAD version

setHeadVersionNum

public ObjectDetails setHeadVersionNum(VersionNum headVersionNum)

getDigestAlgorithm

public DigestAlgorithm getDigestAlgorithm()

Returns:

the digest algorithm used to identify files within the OCFL object

setDigestAlgorithm

public ObjectDetails setDigestAlgorithm(DigestAlgorithm digestAlgorithm)

getVersionMap

public Map<VersionNum,VersionDetails> getVersionMap()

Map of version number to version details for all of the versions of the object.

Returns:

map of all of the object's versions

getVersion

public VersionDetails getVersion(VersionNum versionNum)

Returns the VersionDetails for the specified version number or null if the version does not exist

Parameters:

versionNum - the version number of the version to retrieve

Returns:

version details or null

setVersions

public ObjectDetails setVersions(Map<VersionNum,VersionDetails> versions)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object