Package io.ocfl.api.model

Class ObjectDetails

java.lang.Object
io.ocfl.api.model.ObjectDetails
public class ObjectDetails extends Object
Details the current state of an object and all of its versions.

  • Constructor Details

    • ObjectDetails

      public ObjectDetails()

  • Method Details

    • 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)

    • getObjectOcflVersion

      public OcflVersion getObjectOcflVersion()
      Returns:
      the OCFL version the object adheres to

    • setObjectOcflVersion

      public ObjectDetails setObjectOcflVersion(OcflVersion objectOcflVersion)

    • 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