Skip to content

Commit

Permalink
Update 'ObjectMetadata' class javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
doulikecookiedough committed Jan 24, 2024
1 parent 2e51201 commit 4400215
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions src/main/java/org/dataone/hashstore/ObjectMetadata.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

/**
* ObjectMetadata is a class that models a unique identifier for an object in the HashStore. It
* encapsulates information about a file's id, size, and associated hash digest values. By using
* ObjectMetadata objects, client code can easily obtain metadata of a store object in HashStore
* without needing to know the underlying file system details.
* encapsulates information about a file's content identifier (cid), size, and associated hash
* digest values. By using ObjectMetadata objects, client code can easily obtain metadata of a store
* object in HashStore without needing to know the underlying file system details.
*/
public class ObjectMetadata {
private final String cid;
Expand All @@ -16,7 +16,7 @@ public class ObjectMetadata {
/**
* Creates a new instance of ObjectMetadata with the given properties.
*
* @param id Unique identifier for the file
* @param cid Unique identifier for the file
* @param size Size of stored file
* @param hexDigests A map of hash algorithm names to their hex-encoded digest values for the
* file
Expand All @@ -28,9 +28,9 @@ public ObjectMetadata(String cid, long size, Map<String, String> hexDigests) {
}

/**
* Return the id (address) of the file
* Return the cid (content identifier) of the file
*
* @return id
* @return cid
*/
public String getCid() {
return cid;
Expand All @@ -39,14 +39,14 @@ public String getCid() {
/**
* Return the size of the file
*
* @return id
* @return size
*/
public long getSize() {
return size;
}

/**
* Return a map of hex digests
* Return a map of hex digests (checksums)
*
* @return hexDigests
*/
Expand Down

0 comments on commit 4400215

Please sign in to comment.