Index (OCFL Java API 2.2.0 API)

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addDigest(DigestAlgorithm, String) - Method in class io.ocfl.api.model.FileDetails
addFileFixity(String, DigestAlgorithm, String) - Method in interface io.ocfl.api.OcflObjectUpdater: Adds an entry to the object's fixity block.
addPath(Path, OcflOption...) - Method in interface io.ocfl.api.OcflObjectUpdater: Adds a file or directory to the object.
addPath(Path, String, OcflOption...) - Method in interface io.ocfl.api.OcflObjectUpdater: Adds a file or directory to the object at the specified destinationPath.
ALLOWED_DIGEST_ALGORITHMS - Static variable in class io.ocfl.api.OcflConstants
AlreadyExistsException - Exception Class in io.ocfl.api.exception: This exception indicates that the operation could not be completed because the targeted resource already exists
AlreadyExistsException() - Constructor for exception class io.ocfl.api.exception.AlreadyExistsException
AlreadyExistsException(String) - Constructor for exception class io.ocfl.api.exception.AlreadyExistsException
AlreadyExistsException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.AlreadyExistsException
AlreadyExistsException(Throwable) - Constructor for exception class io.ocfl.api.exception.AlreadyExistsException

B

blake2b160 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
blake2b256 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
blake2b384 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
blake2b512 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry

C

checkFixity() - Method in class io.ocfl.api.io.FixityCheckChannel: Performs a fixity check and throws an exception if the check fails.
checkFixity() - Method in class io.ocfl.api.io.FixityCheckInputStream: Performs a fixity check and throws an exception if the check fails.
clearFixityBlock() - Method in interface io.ocfl.api.OcflObjectUpdater: Clears the object's fixity block.
clearVersionState() - Method in interface io.ocfl.api.OcflObjectUpdater: The state of the current version of the object is cleared so that it does not reference any files.
close() - Method in class io.ocfl.api.io.FixityCheckChannel
close() - Method in interface io.ocfl.api.OcflRepository: Closes any resources the OcflRepository may have open, such as ExecutorServices.
commitStagedChanges(String, VersionInfo) - Method in interface io.ocfl.api.MutableOcflRepository: Converts the staged changes in the mutable HEAD into an immutable core OCFL version that can be read by any OCFL client.
compareTo(VersionNum) - Method in class io.ocfl.api.model.VersionNum
config() - Method in interface io.ocfl.api.OcflRepository: Returns a copy of the OCFL configuration.
contains(OcflOption, OcflOption...) - Static method in enum class io.ocfl.api.OcflOption: Returns true if the set of options contains the specified option
containsFile(String) - Method in class io.ocfl.api.model.OcflObjectVersion: Returns true if the version contains a file at the specified path
containsFile(String) - Method in class io.ocfl.api.model.VersionDetails: Returns true if the version contains a file at the specified path
containsObject(String) - Method in interface io.ocfl.api.OcflRepository: Returns true if an object with the specified id exists in the repository.
CorruptObjectException - Exception Class in io.ocfl.api.exception: This exception indicates that there is something wrong with the underlying OCFL object, and it cannot be operated on by the ocfl-java library.
CorruptObjectException() - Constructor for exception class io.ocfl.api.exception.CorruptObjectException
CorruptObjectException(String) - Constructor for exception class io.ocfl.api.exception.CorruptObjectException
CorruptObjectException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.CorruptObjectException
CorruptObjectException(Throwable) - Constructor for exception class io.ocfl.api.exception.CorruptObjectException

D

DEFAULT_CONTENT_DIRECTORY - Static variable in class io.ocfl.api.OcflConstants
DEFAULT_DIGEST_ALGORITHM - Static variable in class io.ocfl.api.OcflConstants
DEFAULT_OCFL_VERSION - Static variable in class io.ocfl.api.OcflConstants
DEFAULT_ZERO_PADDING_WIDTH - Static variable in class io.ocfl.api.OcflConstants
describeObject(String) - Method in interface io.ocfl.api.OcflRepository: Returns all of the details about an object and all of its versions.
describeVersion(ObjectVersionId) - Method in interface io.ocfl.api.OcflRepository: Returns the details about a specific version of an object.
DIGEST_ALGORITHMS_EXT_NAME - Static variable in class io.ocfl.api.OcflConstants
DigestAlgorithm - Class in io.ocfl.api.model: Maps OCFL defined digest algorithms to their Java names.
DigestAlgorithm(String, String) - Constructor for class io.ocfl.api.model.DigestAlgorithm
DigestAlgorithmRegistry - Class in io.ocfl.api: Registry of digest algorithms.

E

E001 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E002 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E003 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E004 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E005 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E006 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E007 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E008 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E009 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E010 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E011 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E012 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E013 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E014 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E015 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E016 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E017 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E018 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E019 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E020 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E021 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E022 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E023 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E024 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E025 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E026 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E027 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E028 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E029 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E030 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E031 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E032 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E033 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E034 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E035 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E036 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E037 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E038 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E039 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E040 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E041 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E042 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E043 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E044 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E045 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E046 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E047 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E048 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E049 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E050 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E051 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E052 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E053 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E054 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E055 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E056 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E057 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E058 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E059 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E060 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E061 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E062 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E063 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E064 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E066 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E067 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E069 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E070 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E071 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E072 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E073 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E074 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E075 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E076 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E077 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E078 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E079 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E080 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E081 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E082 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E083 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E084 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E085 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E086 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E087 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E088 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E089 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E090 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E091 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E092 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E093 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E094 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E095 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E096 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E097 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E098 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E099 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E100 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E101 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E102 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E103 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E104 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E105 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E106 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E107 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E108 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E109 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E110 - Enum constant in enum class io.ocfl.api.model.ValidationCode
E111 - Enum constant in enum class io.ocfl.api.model.ValidationCode
enableFixityCheck(boolean) - Method in class io.ocfl.api.io.FixityCheckChannel: By default fixity checking is enabled.
enableFixityCheck(boolean) - Method in class io.ocfl.api.io.FixityCheckInputStream: By default fixity checking is enabled.
encode(byte[]) - Method in class io.ocfl.api.model.DigestAlgorithm: Encodes a binary digest value into a string representation.
encode(byte[]) - Method in class io.ocfl.api.model.SizeDigestAlgorithm
encode(byte[]) - Method in class io.ocfl.api.model.StandardDigestAlgorithm
Enforce - Class in io.ocfl.api.util
equals(Object) - Method in class io.ocfl.api.model.DigestAlgorithm
equals(Object) - Method in class io.ocfl.api.model.FileDetails
equals(Object) - Method in class io.ocfl.api.model.ObjectDetails
equals(Object) - Method in class io.ocfl.api.model.ObjectVersionId
equals(Object) - Method in class io.ocfl.api.model.User
equals(Object) - Method in class io.ocfl.api.model.VersionDetails
equals(Object) - Method in class io.ocfl.api.model.VersionInfo
equals(Object) - Method in class io.ocfl.api.model.VersionNum
ERROR - Enum constant in enum class io.ocfl.api.model.ValidationCode.Type
exportObject(String, Path, OcflOption...) - Method in interface io.ocfl.api.OcflRepository: Copies a raw OCFL object to the specified directory.
exportVersion(ObjectVersionId, Path, OcflOption...) - Method in interface io.ocfl.api.OcflRepository: Copies a raw OCFL object version to the specified directory.
expressionTrue(boolean, T, String) - Static method in class io.ocfl.api.util.Enforce
EXT_CONFIG_JSON - Static variable in class io.ocfl.api.OcflConstants
EXTENSIONS_DIR - Static variable in class io.ocfl.api.OcflConstants

F

FileChange - Class in io.ocfl.api.model: Details about a change to a file.
FileChange() - Constructor for class io.ocfl.api.model.FileChange
fileChangeHistory(String, String) - Method in interface io.ocfl.api.OcflRepository: Retrieves the complete change history for a logical path within an object.
FileChangeHistory - Class in io.ocfl.api.model: Contains the complete change history of a file.
FileChangeHistory() - Constructor for class io.ocfl.api.model.FileChangeHistory
FileChangeType - Enum Class in io.ocfl.api.model: The type of change that occurred to a file in a version
FileDetails - Class in io.ocfl.api.model: Encapsulates a filePath with all of its fixity information.
FileDetails() - Constructor for class io.ocfl.api.model.FileDetails
FixityCheckChannel - Class in io.ocfl.api.io: A byte channel wrapper that preforms a fixity check on the bytes that pass through an underlying byte channel.
FixityCheckChannel(ByteChannel, DigestAlgorithm, String) - Constructor for class io.ocfl.api.io.FixityCheckChannel: Constructs a new FixityCheckChannel
FixityCheckException - Exception Class in io.ocfl.api.exception: Indicates that a calculated digest does not match the expected digest
FixityCheckException() - Constructor for exception class io.ocfl.api.exception.FixityCheckException
FixityCheckException(String) - Constructor for exception class io.ocfl.api.exception.FixityCheckException
FixityCheckException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.FixityCheckException
FixityCheckException(Throwable) - Constructor for exception class io.ocfl.api.exception.FixityCheckException
FixityCheckInputStream - Class in io.ocfl.api.io: Wrapper around Java's DigestInputStream to compute a digest while streaming data, and then verify the fixity of the data.
FixityCheckInputStream(InputStream, DigestAlgorithm, String) - Constructor for class io.ocfl.api.io.FixityCheckInputStream
from(IOException) - Static method in exception class io.ocfl.api.exception.OcflIOException: Wraps an IO exception in the appropriate wrapper class.
fromInt(int) - Static method in class io.ocfl.api.model.VersionNum: Creates a new VersionNum from an integer.
fromOcflName(String) - Static method in class io.ocfl.api.model.DigestAlgorithm: Creates a DigestAlgorithm for the given OCFL name.
fromOcflName(String, String) - Static method in class io.ocfl.api.model.DigestAlgorithm: Creates a DigestAlgorithm for the given OCFL name.
fromOcflObjectVersionFilename(String) - Static method in enum class io.ocfl.api.model.OcflVersion: Returns an OCFL version based on the name of an OCFL object Namaste file
fromOcflObjectVersionString(String) - Static method in enum class io.ocfl.api.model.OcflVersion: Returns an OCFL version based on the OCFL version string specified in the Namaste file in an OCFL object.
fromOcflVersionFilename(String) - Static method in enum class io.ocfl.api.model.OcflVersion: Returns an OCFL version based on the name of an OCFL storage root Namaste file
fromOcflVersionString(String) - Static method in enum class io.ocfl.api.model.OcflVersion: Returns an OCFL version based on the OCFL version string specified in the Namaste file in the OCFL storage root.
fromString(String) - Static method in class io.ocfl.api.model.VersionNum: Creates a new VersionNum from a version string in the format of "vN" where "N" is an integer greater than -1.
fromValue(String) - Static method in enum class io.ocfl.api.model.InventoryType

G

getActualDigestValue() - Method in class io.ocfl.api.io.FixityCheckInputStream: Returns the hex encoded digest value of the input stream.
getAddress() - Method in class io.ocfl.api.model.User: URI identifying the user
getAlgorithm(String) - Static method in class io.ocfl.api.DigestAlgorithmRegistry: Retrieves the algorithm that corresponds to the OCFL name from the registry
getChangeType() - Method in class io.ocfl.api.model.FileChange: The type of change that occurred, UPDATE/REMOVE.
getCode() - Method in class io.ocfl.api.model.ValidationIssue
getCreated() - Method in class io.ocfl.api.model.OcflObjectVersion: The timestamp of when the version was created
getCreated() - Method in class io.ocfl.api.model.VersionDetails: The timestamp of when the version was created
getCreated() - Method in class io.ocfl.api.model.VersionInfo: The timestamp when the version was created
getDefaultContentDirectory() - Method in class io.ocfl.api.OcflConfig
getDefaultDigestAlgorithm() - Method in class io.ocfl.api.OcflConfig
getDefaultZeroPaddingWidth() - Method in class io.ocfl.api.OcflConfig
getDigestAlgorithm() - Method in class io.ocfl.api.model.ObjectDetails
getErrors() - Method in class io.ocfl.api.model.ValidationResults
getExpectedDigestValue() - Method in class io.ocfl.api.io.FixityCheckChannel
getExpectedDigestValue() - Method in class io.ocfl.api.io.FixityCheckInputStream
getFile(String) - Method in class io.ocfl.api.model.OcflObjectVersion: Returns the OcflObjectVersionFile for the file at the given path or null if it does not exist
getFile(String) - Method in class io.ocfl.api.model.VersionDetails: Returns the FileDetails for the file at the given path or null if it does not exist
getFileChanges() - Method in class io.ocfl.api.model.FileChangeHistory: An ordered list, oldest to newest, of every change that occurred to the file
getFileMap() - Method in class io.ocfl.api.model.VersionDetails: Returns a map of logical paths to file details that represents the state of the object at this version.
getFiles() - Method in class io.ocfl.api.model.OcflObjectVersion: Collection of all of the files in this version of the object
getFiles() - Method in class io.ocfl.api.model.VersionDetails: Collection of all of the files in this version of the object
getFixity() - Method in class io.ocfl.api.model.FileChange: Map of digest algorithm to digest value.
getFixity() - Method in class io.ocfl.api.model.FileDetails: Map of digest algorithm to digest value.
getFixity() - Method in class io.ocfl.api.model.OcflObjectVersionFile: Map of digest algorithm to digest value.
getForwardChangeIterator() - Method in class io.ocfl.api.model.FileChangeHistory: Iterator for traversing file changes from oldest to newest
getHeadVersion() - Method in class io.ocfl.api.model.ObjectDetails: The version details of the HEAD version of the object
getHeadVersionNum() - Method in class io.ocfl.api.model.ObjectDetails: The version number of the HEAD version of the object
getId() - Method in enum class io.ocfl.api.model.InventoryType
getId() - Method in class io.ocfl.api.model.ObjectDetails
getInfos() - Method in class io.ocfl.api.model.ValidationResults
getInventoryType() - Method in enum class io.ocfl.api.model.OcflVersion
getJavaStandardName() - Method in class io.ocfl.api.model.DigestAlgorithm: The Java name for the digest algorithm.
getMessage() - Method in exception class io.ocfl.api.exception.OcflFileAlreadyExistsException
getMessage() - Method in exception class io.ocfl.api.exception.OcflIOException
getMessage() - Method in exception class io.ocfl.api.exception.OcflNoSuchFileException
getMessage() - Method in exception class io.ocfl.api.exception.ValidationException
getMessage() - Method in class io.ocfl.api.model.ValidationIssue
getMessage() - Method in class io.ocfl.api.model.VersionInfo: Description of version changes
getMessageDigest() - Method in class io.ocfl.api.model.DigestAlgorithm: Creates a new MessageDigest that implements the digest algorithm
getMessageDigest() - Method in class io.ocfl.api.model.SizeDigestAlgorithm
getMessageDigest() - Method in class io.ocfl.api.model.StandardDigestAlgorithm
getMostRecent() - Method in class io.ocfl.api.model.FileChangeHistory: The most recent file change to occur
getName() - Method in class io.ocfl.api.model.User: Name of the user
getObject(ObjectVersionId) - Method in interface io.ocfl.api.OcflRepository: Returns the details about a specific version of an object along with lazy-loading handles to all of the files in the object.
getObject(ObjectVersionId, Path) - Method in interface io.ocfl.api.OcflRepository: Returns the entire contents of the object at the specified version.
getObjectId() - Method in class io.ocfl.api.model.ObjectVersionId: The object id
getObjectId() - Method in class io.ocfl.api.model.OcflObjectVersion: The object's id
getObjectId() - Method in class io.ocfl.api.model.VersionDetails: The object's id
getObjectOcflVersion() - Method in class io.ocfl.api.model.ObjectDetails
getObjectOcflVersion() - Method in class io.ocfl.api.model.VersionDetails
getObjectVersionId() - Method in class io.ocfl.api.model.FileChange: The ObjectVersionId for the version the changed occurred in
getObjectVersionId() - Method in class io.ocfl.api.model.OcflObjectVersion: The ObjectId of the version
getObjectVersionId() - Method in class io.ocfl.api.model.VersionDetails: The ObjectVersionId of the version
getOcflName() - Method in class io.ocfl.api.model.DigestAlgorithm: The OCFL name for the digest algorithm.
getOcflObjectVersion() - Method in enum class io.ocfl.api.model.OcflVersion
getOcflVersion() - Method in enum class io.ocfl.api.model.InventoryType
getOcflVersion() - Method in enum class io.ocfl.api.model.OcflVersion
getOcflVersion() - Method in class io.ocfl.api.OcflConfig
getOldest() - Method in class io.ocfl.api.model.FileChangeHistory: The oldest change to occur.
getPath() - Method in class io.ocfl.api.model.FileChange: The file's logical path
getPath() - Method in class io.ocfl.api.model.FileChangeHistory: The logical path of the file
getPath() - Method in class io.ocfl.api.model.FileDetails: The file's logical path within the object
getPath() - Method in class io.ocfl.api.model.OcflObjectVersionFile: The file's logical path within the object
getRawVersion() - Method in enum class io.ocfl.api.model.OcflVersion
getReverseChangeIterator() - Method in class io.ocfl.api.model.FileChangeHistory: Iterator for traversing file changes from newest to oldest.
getStorageRelativePath() - Method in class io.ocfl.api.model.FileChange: The file's path relative to the storage root.
getStorageRelativePath() - Method in class io.ocfl.api.model.FileDetails: The file's path relative to the storage root
getStorageRelativePath() - Method in class io.ocfl.api.model.OcflObjectVersionFile: The file's path relative to the storage root
getStream() - Method in class io.ocfl.api.model.OcflObjectVersionFile: Returns a new input stream of the file's content.
getTimestamp() - Method in class io.ocfl.api.model.FileChange: The timestamp when the file changed
getType() - Method in enum class io.ocfl.api.model.ValidationCode
getUser() - Method in class io.ocfl.api.model.VersionInfo: The user who authored the version
getValidationResults() - Method in exception class io.ocfl.api.exception.ValidationException
getVersion(VersionNum) - Method in class io.ocfl.api.model.ObjectDetails: Returns the VersionDetails for the specified version number or null if the version does not exist
getVersionInfo() - Method in class io.ocfl.api.model.FileChange: Description of the version
getVersionInfo() - Method in class io.ocfl.api.model.OcflObjectVersion: Optional description of the version
getVersionInfo() - Method in class io.ocfl.api.model.VersionDetails: Description of the version
getVersionMap() - Method in class io.ocfl.api.model.ObjectDetails: Map of version number to version details for all of the versions of the object.
getVersionNum() - Method in class io.ocfl.api.model.FileChange: The object's version number for the version the changed occurred in
getVersionNum() - Method in class io.ocfl.api.model.ObjectVersionId: The version number
getVersionNum() - Method in class io.ocfl.api.model.OcflObjectVersion: The version number
getVersionNum() - Method in class io.ocfl.api.model.VersionDetails: The version number of this version
getVersionNum() - Method in class io.ocfl.api.model.VersionNum
getWarnings() - Method in class io.ocfl.api.model.ValidationResults
getZeroPaddingWidth() - Method in class io.ocfl.api.model.VersionNum

H

hasErrors() - Method in class io.ocfl.api.model.ValidationResults
hashCode() - Method in class io.ocfl.api.model.DigestAlgorithm
hashCode() - Method in class io.ocfl.api.model.FileDetails
hashCode() - Method in class io.ocfl.api.model.ObjectDetails
hashCode() - Method in class io.ocfl.api.model.ObjectVersionId
hashCode() - Method in class io.ocfl.api.model.User
hashCode() - Method in class io.ocfl.api.model.VersionDetails
hashCode() - Method in class io.ocfl.api.model.VersionInfo
hashCode() - Method in class io.ocfl.api.model.VersionNum
hasInfos() - Method in class io.ocfl.api.model.ValidationResults
hasJavaStandardName() - Method in class io.ocfl.api.model.DigestAlgorithm: Indicates whether or not there is a Java mapping for the algorithm.
hasStagedChanges(String) - Method in interface io.ocfl.api.MutableOcflRepository: Returns true if the object has staged changes (mutable HEAD).
hasWarnings() - Method in class io.ocfl.api.model.ValidationResults
head(String) - Static method in class io.ocfl.api.model.ObjectVersionId: Creates an ObjectId instance that points to the HEAD version of the object

I

importObject(Path, OcflOption...) - Method in interface io.ocfl.api.OcflRepository: Imports an entire OCFL object into the repository.
importVersion(Path, OcflOption...) - Method in interface io.ocfl.api.OcflRepository: Imports the OCFL object version at the specified path into the repository.
INFO - Enum constant in enum class io.ocfl.api.model.ValidationCode.Type
INIT_EXT - Static variable in class io.ocfl.api.OcflConstants
invalidateCache() - Method in interface io.ocfl.api.OcflRepository: If the OcflRepository is using an inventory cache, then this method invalidates all entries in the cache.
invalidateCache(String) - Method in interface io.ocfl.api.OcflRepository: If the OcflRepository is using an inventory cache, then this method invalidates the cache entry for the specified object.
InvalidInventoryException - Exception Class in io.ocfl.api.exception: This exception indicates that there is something wrong with an object's inventory.
InvalidInventoryException() - Constructor for exception class io.ocfl.api.exception.InvalidInventoryException
InvalidInventoryException(String) - Constructor for exception class io.ocfl.api.exception.InvalidInventoryException
InvalidInventoryException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.InvalidInventoryException
InvalidInventoryException(Throwable) - Constructor for exception class io.ocfl.api.exception.InvalidInventoryException
InvalidVersionException - Exception Class in io.ocfl.api.exception: This exception indicates that a version number is invalid
InvalidVersionException() - Constructor for exception class io.ocfl.api.exception.InvalidVersionException
InvalidVersionException(String) - Constructor for exception class io.ocfl.api.exception.InvalidVersionException
InvalidVersionException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.InvalidVersionException
InvalidVersionException(Throwable) - Constructor for exception class io.ocfl.api.exception.InvalidVersionException
INVENTORY_FILE - Static variable in class io.ocfl.api.OcflConstants
INVENTORY_SIDECAR_PREFIX - Static variable in class io.ocfl.api.OcflConstants
InventoryType - Enum Class in io.ocfl.api.model
io.ocfl.api - package io.ocfl.api
io.ocfl.api.exception - package io.ocfl.api.exception
io.ocfl.api.io - package io.ocfl.api.io
io.ocfl.api.model - package io.ocfl.api.model
io.ocfl.api.util - package io.ocfl.api.util
isHead() - Method in class io.ocfl.api.model.ObjectVersionId
isMutable() - Method in class io.ocfl.api.model.OcflObjectVersion: Returns true only if the version is a mutable HEAD version that is used to stage changes.
isMutable() - Method in class io.ocfl.api.model.VersionDetails: Returns true only if the version is a mutable HEAD version that is used to stage changes.
isOpen() - Method in class io.ocfl.api.io.FixityCheckChannel
isUpgradeObjectsOnWrite() - Method in class io.ocfl.api.OcflConfig

L

listObjectIds() - Method in interface io.ocfl.api.OcflRepository: Returns a stream of OCFL object ids for all of the objects stored in the repository.
LockException - Exception Class in io.ocfl.api.exception: Indicates that the current thread was unable to acquire a lock
LockException() - Constructor for exception class io.ocfl.api.exception.LockException
LockException(String) - Constructor for exception class io.ocfl.api.exception.LockException
LockException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.LockException
LockException(Throwable) - Constructor for exception class io.ocfl.api.exception.LockException
LOGS_DIR - Static variable in class io.ocfl.api.OcflConstants

M

md5 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
MOVE_SOURCE - Enum constant in enum class io.ocfl.api.OcflOption: Instructs an update operation to move files into the repository instead of copying them.
MUTABLE_HEAD_EXT_NAME - Static variable in class io.ocfl.api.OcflConstants
MUTABLE_HEAD_EXT_PATH - Static variable in class io.ocfl.api.OcflConstants
MUTABLE_HEAD_REVISIONS_PATH - Static variable in class io.ocfl.api.OcflConstants
MUTABLE_HEAD_VERSION_PATH - Static variable in class io.ocfl.api.OcflConstants
MutableOcflRepository - Interface in io.ocfl.api: Defines APIs for implementing the OCFL Mutable HEAD Extension.

N

nextVersion() - Method in class io.ocfl.api.model.ObjectVersionId: Returns a new ObjectVersionId instance with an incremented version number.
nextVersionNum() - Method in class io.ocfl.api.model.VersionNum: Returns a new VersionNum that is one more than this.
NO_VALIDATION - Enum constant in enum class io.ocfl.api.OcflOption: Disables validations that ensure the integrity of OCFL objects
notBlank(String, String) - Static method in class io.ocfl.api.util.Enforce
NotFoundException - Exception Class in io.ocfl.api.exception: Indicates that a resource was not found
NotFoundException() - Constructor for exception class io.ocfl.api.exception.NotFoundException
NotFoundException(String) - Constructor for exception class io.ocfl.api.exception.NotFoundException
NotFoundException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.NotFoundException
NotFoundException(Throwable) - Constructor for exception class io.ocfl.api.exception.NotFoundException
notNull(T, String) - Static method in class io.ocfl.api.util.Enforce

O

OBJECT_NAMASTE_PREFIX - Static variable in class io.ocfl.api.OcflConstants
ObjectDetails - Class in io.ocfl.api.model: Details the current state of an object and all of its versions.
ObjectDetails() - Constructor for class io.ocfl.api.model.ObjectDetails
ObjectOutOfSyncException - Exception Class in io.ocfl.api.exception: Indicates that an operation could not be completed because the request is out of sync with the current object state on disk.
ObjectOutOfSyncException() - Constructor for exception class io.ocfl.api.exception.ObjectOutOfSyncException
ObjectOutOfSyncException(String) - Constructor for exception class io.ocfl.api.exception.ObjectOutOfSyncException
ObjectOutOfSyncException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.ObjectOutOfSyncException
ObjectOutOfSyncException(Throwable) - Constructor for exception class io.ocfl.api.exception.ObjectOutOfSyncException
ObjectVersionId - Class in io.ocfl.api.model: Points to a specific version of an object, encapsulating an object identifier and version number.
OCFL_1_0 - Enum constant in enum class io.ocfl.api.model.InventoryType
OCFL_1_0 - Enum constant in enum class io.ocfl.api.model.OcflVersion
OCFL_1_1 - Enum constant in enum class io.ocfl.api.model.InventoryType
OCFL_1_1 - Enum constant in enum class io.ocfl.api.model.OcflVersion
OCFL_LAYOUT - Static variable in class io.ocfl.api.OcflConstants
OcflConfig - Class in io.ocfl.api: Contains OCFL related configuration options.
OcflConfig() - Constructor for class io.ocfl.api.OcflConfig
OcflConfig(OcflConfig) - Constructor for class io.ocfl.api.OcflConfig
OcflConstants - Class in io.ocfl.api
OcflDbException - Exception Class in io.ocfl.api.exception: This exception indicates that there was a problem with a DB operation
OcflDbException() - Constructor for exception class io.ocfl.api.exception.OcflDbException
OcflDbException(String) - Constructor for exception class io.ocfl.api.exception.OcflDbException
OcflDbException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.OcflDbException
OcflDbException(Throwable) - Constructor for exception class io.ocfl.api.exception.OcflDbException
OcflExtensionException - Exception Class in io.ocfl.api.exception: This exception indicates that there was a problem with an OCFL extension
OcflExtensionException() - Constructor for exception class io.ocfl.api.exception.OcflExtensionException
OcflExtensionException(String) - Constructor for exception class io.ocfl.api.exception.OcflExtensionException
OcflExtensionException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.OcflExtensionException
OcflExtensionException(Throwable) - Constructor for exception class io.ocfl.api.exception.OcflExtensionException
OcflFileAlreadyExistsException - Exception Class in io.ocfl.api.exception: This exception is a wrapper around FileAlreadyExistsException
OcflFileAlreadyExistsException(Exception) - Constructor for exception class io.ocfl.api.exception.OcflFileAlreadyExistsException
OcflFileAlreadyExistsException(String) - Constructor for exception class io.ocfl.api.exception.OcflFileAlreadyExistsException
OcflFileAlreadyExistsException(String, Exception) - Constructor for exception class io.ocfl.api.exception.OcflFileAlreadyExistsException
OcflFileRetriever - Interface in io.ocfl.api: This class is used to lazy-load object files.
OcflInputException - Exception Class in io.ocfl.api.exception: This is a generic exception that indicates that there was something wrong with an input to ocfl-java
OcflInputException() - Constructor for exception class io.ocfl.api.exception.OcflInputException
OcflInputException(String) - Constructor for exception class io.ocfl.api.exception.OcflInputException
OcflInputException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.OcflInputException
OcflInputException(Throwable) - Constructor for exception class io.ocfl.api.exception.OcflInputException
OcflIOException - Exception Class in io.ocfl.api.exception: This exception is a wrapper around an IOException
OcflIOException(Exception) - Constructor for exception class io.ocfl.api.exception.OcflIOException
OcflIOException(String) - Constructor for exception class io.ocfl.api.exception.OcflIOException
OcflIOException(String, Exception) - Constructor for exception class io.ocfl.api.exception.OcflIOException
OcflJavaException - Exception Class in io.ocfl.api.exception: Base exception class for ocfl-java exceptions
OcflJavaException() - Constructor for exception class io.ocfl.api.exception.OcflJavaException
OcflJavaException(String) - Constructor for exception class io.ocfl.api.exception.OcflJavaException
OcflJavaException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.OcflJavaException
OcflJavaException(Throwable) - Constructor for exception class io.ocfl.api.exception.OcflJavaException
OcflNoSuchFileException - Exception Class in io.ocfl.api.exception: This exception is a wrapper around NoSuchFileException and FileNotFoundException
OcflNoSuchFileException(Exception) - Constructor for exception class io.ocfl.api.exception.OcflNoSuchFileException
OcflNoSuchFileException(String) - Constructor for exception class io.ocfl.api.exception.OcflNoSuchFileException
OcflNoSuchFileException(String, Exception) - Constructor for exception class io.ocfl.api.exception.OcflNoSuchFileException
OcflObjectUpdater - Interface in io.ocfl.api: Exposes methods for selectively updating a specific OCFL object.
OcflObjectVersion - Class in io.ocfl.api.model: View of a specific version of an OCFL object that allows its files to be lazy-loaded.
OcflObjectVersion(VersionDetails, Map<String, OcflObjectVersionFile>) - Constructor for class io.ocfl.api.model.OcflObjectVersion
OcflObjectVersionFile - Class in io.ocfl.api.model: Represents a file within an OCFL object at a specific version.
OcflObjectVersionFile(FileDetails, OcflFileRetriever) - Constructor for class io.ocfl.api.model.OcflObjectVersionFile
OcflOption - Enum Class in io.ocfl.api
OcflRepository - Interface in io.ocfl.api: Interface for interacting with an OCFL repository.
OcflStateException - Exception Class in io.ocfl.api.exception: This is a generic exception that indicates that a state constraint was violated
OcflStateException() - Constructor for exception class io.ocfl.api.exception.OcflStateException
OcflStateException(String) - Constructor for exception class io.ocfl.api.exception.OcflStateException
OcflStateException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.OcflStateException
OcflStateException(Throwable) - Constructor for exception class io.ocfl.api.exception.OcflStateException
OcflVersion - Enum Class in io.ocfl.api.model: Represents a version of the OCFL spec.
on(boolean) - Method in class io.ocfl.api.io.FixityCheckInputStream
OVERWRITE - Enum constant in enum class io.ocfl.api.OcflOption: Instructs an update operation to overwrite existing files in an object.
OverwriteException - Exception Class in io.ocfl.api.exception: Indicates that file already exists and could not be overwritten.
OverwriteException() - Constructor for exception class io.ocfl.api.exception.OverwriteException
OverwriteException(String) - Constructor for exception class io.ocfl.api.exception.OverwriteException
OverwriteException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.OverwriteException
OverwriteException(Throwable) - Constructor for exception class io.ocfl.api.exception.OverwriteException

P

PathConstraintException - Exception Class in io.ocfl.api.exception: Indicates when a path has failed a constraint check.
PathConstraintException() - Constructor for exception class io.ocfl.api.exception.PathConstraintException
PathConstraintException(String) - Constructor for exception class io.ocfl.api.exception.PathConstraintException
PathConstraintException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.PathConstraintException
PathConstraintException(Throwable) - Constructor for exception class io.ocfl.api.exception.PathConstraintException
previousVersion() - Method in class io.ocfl.api.model.ObjectVersionId: Returns a new ObjectVersionId instance with an decremented version number.
previousVersionNum() - Method in class io.ocfl.api.model.VersionNum: Returns a new VersionNum that is one less than this.
purgeObject(String) - Method in interface io.ocfl.api.OcflRepository: Permanently removes an object from the repository.
purgeStagedChanges(String) - Method in interface io.ocfl.api.MutableOcflRepository: Deletes the staged changes (mutable HEAD) of the specified object.
putObject(ObjectVersionId, Path, VersionInfo, OcflOption...) - Method in interface io.ocfl.api.OcflRepository: Adds the object rooted at the given path to the OCFL repository under the given objectVersionId.

R

read(ByteBuffer) - Method in class io.ocfl.api.io.FixityCheckChannel
register(DigestAlgorithm) - Static method in class io.ocfl.api.DigestAlgorithmRegistry: Adds a new algorithm to the registry
reinstateFile(VersionNum, String, String, OcflOption...) - Method in interface io.ocfl.api.OcflObjectUpdater: Reinstates a file that existed in any version of the object into the current version.
REMOVE - Enum constant in enum class io.ocfl.api.model.FileChangeType: Indicates the file was removed
removeFile(String) - Method in interface io.ocfl.api.OcflObjectUpdater: Removes a file from the object.
renameFile(String, String, OcflOption...) - Method in interface io.ocfl.api.OcflObjectUpdater: Renames an existing file within the object.
replicateVersionAsHead(ObjectVersionId, VersionInfo) - Method in interface io.ocfl.api.OcflRepository: Creates a new head version by copying the state of the specified version.
RepositoryConfigurationException - Exception Class in io.ocfl.api.exception: This exception indicates that there is something wrong with the OCFL repository configuration
RepositoryConfigurationException() - Constructor for exception class io.ocfl.api.exception.RepositoryConfigurationException
RepositoryConfigurationException(String) - Constructor for exception class io.ocfl.api.exception.RepositoryConfigurationException
RepositoryConfigurationException(String, Throwable) - Constructor for exception class io.ocfl.api.exception.RepositoryConfigurationException
RepositoryConfigurationException(Throwable) - Constructor for exception class io.ocfl.api.exception.RepositoryConfigurationException
retrieveFile() - Method in interface io.ocfl.api.OcflFileRetriever: Returns a new input stream of the file's content.
rollbackToVersion(ObjectVersionId) - Method in interface io.ocfl.api.OcflRepository: Rolls an object back to the specified version.

S

setAddress(String) - Method in class io.ocfl.api.model.User
setChangeType(FileChangeType) - Method in class io.ocfl.api.model.FileChange
setCreated(OffsetDateTime) - Method in class io.ocfl.api.model.VersionDetails
setCreated(OffsetDateTime) - Method in class io.ocfl.api.model.VersionInfo: Sets the verison creation timestamp.
setDefaultContentDirectory(String) - Method in class io.ocfl.api.OcflConfig: Set the default content directory to use when creating new inventories.
setDefaultDigestAlgorithm(DigestAlgorithm) - Method in class io.ocfl.api.OcflConfig: Set the default digest algorithm to use when creating new inventories.
setDefaultZeroPaddingWidth(int) - Method in class io.ocfl.api.OcflConfig: Set the default zero padding width to use in version numbers in newly created objects.
setDigestAlgorithm(DigestAlgorithm) - Method in class io.ocfl.api.model.ObjectDetails
setFileChanges(List<FileChange>) - Method in class io.ocfl.api.model.FileChangeHistory
setFileMap(Map<String, FileDetails>) - Method in class io.ocfl.api.model.VersionDetails
setFixity(Map<DigestAlgorithm, String>) - Method in class io.ocfl.api.model.FileChange
setFixity(Map<DigestAlgorithm, String>) - Method in class io.ocfl.api.model.FileDetails
setHeadVersionNum(VersionNum) - Method in class io.ocfl.api.model.ObjectDetails
setId(String) - Method in class io.ocfl.api.model.ObjectDetails
setMessage(String) - Method in class io.ocfl.api.model.VersionInfo: Sets the version description
setMutable(boolean) - Method in class io.ocfl.api.model.VersionDetails
setName(String) - Method in class io.ocfl.api.model.User
setObjectOcflVersion(OcflVersion) - Method in class io.ocfl.api.model.ObjectDetails
setObjectOcflVersion(OcflVersion) - Method in class io.ocfl.api.model.VersionDetails
setObjectVersionId(ObjectVersionId) - Method in class io.ocfl.api.model.FileChange
setObjectVersionId(ObjectVersionId) - Method in class io.ocfl.api.model.VersionDetails
setOcflVersion(OcflVersion) - Method in class io.ocfl.api.OcflConfig: Set the default OCFL version to use when creating new inventories.
setPath(String) - Method in class io.ocfl.api.model.FileChange
setPath(String) - Method in class io.ocfl.api.model.FileChangeHistory
setPath(String) - Method in class io.ocfl.api.model.FileDetails
setStorageRelativePath(String) - Method in class io.ocfl.api.model.FileChange
setStorageRelativePath(String) - Method in class io.ocfl.api.model.FileDetails
setTimestamp(OffsetDateTime) - Method in class io.ocfl.api.model.FileChange
setUpgradeObjectsOnWrite(boolean) - Method in class io.ocfl.api.OcflConfig: When set to true, existing objects that adhere to an older version of the OCFL spec will be upgraded to the configured OCFL version when they are written to.
setUser(User) - Method in class io.ocfl.api.model.VersionInfo: Sets the user info
setUser(String, String) - Method in class io.ocfl.api.model.VersionInfo: Sets the user info
setVersionInfo(VersionInfo) - Method in class io.ocfl.api.model.FileChange
setVersionInfo(VersionInfo) - Method in class io.ocfl.api.model.VersionDetails
setVersions(Map<VersionNum, VersionDetails>) - Method in class io.ocfl.api.model.ObjectDetails
sha1 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
sha256 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
sha512 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
sha512_256 - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
size - Static variable in class io.ocfl.api.DigestAlgorithmRegistry
SizeDigestAlgorithm - Class in io.ocfl.api.model: Defines a digest algorithms which calculates the size (byte count) for the input and returns it as integer represented as string as specified in OCFL community extension 9
SizeDigestAlgorithm() - Constructor for class io.ocfl.api.model.SizeDigestAlgorithm
stageChanges(ObjectVersionId, VersionInfo, Consumer<OcflObjectUpdater>) - Method in interface io.ocfl.api.MutableOcflRepository: Stages changes to the mutable HEAD of the specified object.
StandardDigestAlgorithm - Class in io.ocfl.api.model: Implementation of DigestAlgorithm that uses a standard MessageDigest and encodes the digest value to a lowercase, hex string.
StandardDigestAlgorithm(String, String) - Constructor for class io.ocfl.api.model.StandardDigestAlgorithm

T

toSet(OcflOption...) - Static method in enum class io.ocfl.api.OcflOption: Transforms a varargs of options into a set
toString() - Method in class io.ocfl.api.io.FixityCheckInputStream
toString() - Method in class io.ocfl.api.model.DigestAlgorithm
toString() - Method in class io.ocfl.api.model.FileChange
toString() - Method in class io.ocfl.api.model.FileChangeHistory
toString() - Method in class io.ocfl.api.model.FileDetails
toString() - Method in class io.ocfl.api.model.ObjectDetails
toString() - Method in class io.ocfl.api.model.ObjectVersionId
toString() - Method in class io.ocfl.api.model.OcflObjectVersion
toString() - Method in class io.ocfl.api.model.OcflObjectVersionFile
toString() - Method in enum class io.ocfl.api.model.OcflVersion
toString() - Method in class io.ocfl.api.model.User
toString() - Method in class io.ocfl.api.model.ValidationIssue
toString() - Method in class io.ocfl.api.model.ValidationResults
toString() - Method in class io.ocfl.api.model.VersionDetails
toString() - Method in class io.ocfl.api.model.VersionInfo
toString() - Method in class io.ocfl.api.model.VersionNum
toString() - Method in class io.ocfl.api.OcflConfig

U

unsafeAddPath(String, Path, String, OcflOption...) - Method in interface io.ocfl.api.OcflObjectUpdater: Adds a file to the object at the specified destinationPath.
UPDATE - Enum constant in enum class io.ocfl.api.model.FileChangeType: Indicates a file content change.
updateObject(ObjectVersionId, VersionInfo, Consumer<OcflObjectUpdater>) - Method in interface io.ocfl.api.OcflRepository: 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.
User - Class in io.ocfl.api.model: Details about the user who authored an object version
User() - Constructor for class io.ocfl.api.model.User

V

V1 - Static variable in class io.ocfl.api.model.VersionNum
VALID_INVENTORY_ALGORITHMS - Static variable in class io.ocfl.api.OcflConstants
validateObject(String, boolean) - Method in interface io.ocfl.api.OcflRepository: Validates an existing object against the OCFL spec and returns a report containing all of the issues that were found with their accompanying validation code.
ValidationCode - Enum Class in io.ocfl.api.model: OCFL validation codes: https://ocfl.io/validation/validation-codes.html
ValidationCode.Type - Enum Class in io.ocfl.api.model
ValidationException - Exception Class in io.ocfl.api.exception: This exception indicates that there were object validation errors
ValidationException(String, ValidationResults) - Constructor for exception class io.ocfl.api.exception.ValidationException
ValidationIssue - Class in io.ocfl.api.model: Encapsulates a validation code and a descriptive message
ValidationIssue(ValidationCode, String) - Constructor for class io.ocfl.api.model.ValidationIssue
ValidationResults - Class in io.ocfl.api.model: Encapsulates the results of validating an object
ValidationResults(List<ValidationIssue>, List<ValidationIssue>, List<ValidationIssue>) - Constructor for class io.ocfl.api.model.ValidationResults
valueOf(String) - Static method in enum class io.ocfl.api.model.FileChangeType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.api.model.InventoryType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.api.model.OcflVersion: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.api.model.ValidationCode.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.api.model.ValidationCode: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class io.ocfl.api.OcflOption: Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.ocfl.api.model.FileChangeType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.api.model.InventoryType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.api.model.OcflVersion: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.api.model.ValidationCode.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.api.model.ValidationCode: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class io.ocfl.api.OcflOption: Returns an array containing the constants of this enum class, in the order they are declared.
version(String, int) - Static method in class io.ocfl.api.model.ObjectVersionId: Creates an ObjectId instance that points to a specific version of an object
version(String, VersionNum) - Static method in class io.ocfl.api.model.ObjectVersionId: Creates an ObjectId instance that points to a specific version of an object
version(String, String) - Static method in class io.ocfl.api.model.ObjectVersionId: Creates an ObjectId instance that points to a specific version of an object
VersionDetails - Class in io.ocfl.api.model: Details about a specific version of an object
VersionDetails() - Constructor for class io.ocfl.api.model.VersionDetails
VersionInfo - Class in io.ocfl.api.model: Descriptive information about an object version.
VersionInfo() - Constructor for class io.ocfl.api.model.VersionInfo
VersionNum - Class in io.ocfl.api.model: Represents an OCFL version number.
VersionNum(long) - Constructor for class io.ocfl.api.model.VersionNum: Creates a new VersionNum.
VersionNum(long, int) - Constructor for class io.ocfl.api.model.VersionNum: Creates a new VersionNum

W

W001 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W002 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W003 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W004 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W005 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W006 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W007 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W008 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W009 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W010 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W011 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W012 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W013 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W014 - Enum constant in enum class io.ocfl.api.model.ValidationCode
W015 - Enum constant in enum class io.ocfl.api.model.ValidationCode
WARN - Enum constant in enum class io.ocfl.api.model.ValidationCode.Type
write(ByteBuffer) - Method in class io.ocfl.api.io.FixityCheckChannel
writeFile(InputStream, String, OcflOption...) - Method in interface io.ocfl.api.OcflObjectUpdater: Writes the contents of the InputStream to the object at the specified destinationPath.

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form