S3FileSystemStore: Add comments for path splitting

dgault · May 14, 2024 · a54a40e · a54a40e
1 parent 2bfe3db
commit a54a40e
Showing 1 changed file with 11 additions and 4 deletions.
diff --git a/src/loci/formats/S3FileSystemStore.java b/src/loci/formats/S3FileSystemStore.java
@@ -123,8 +123,11 @@ public S3FileSystemStore(Path rootPath) {
 
     @Override
     public InputStream getInputStream(String key) throws IOException {
+        // Get the base bucket name from splitting the root path and removing the prefixed protocol and end-point
         String[] pathSplit = root.toString().split(File.separator);
         String bucketName =  pathSplit[2];
+
+        // Append the desired key onto the remaining prefix
         String key2 = root.toString().substring(root.toString().indexOf(pathSplit[3]), root.toString().length()) + File.separator + key;
 
         try {   
@@ -205,10 +208,12 @@ public Stream<String> getRelativeLeafKeys(String key) throws IOException {
 
     private TreeSet<String> getKeysFor(String suffix) throws IOException {
       TreeSet<String> keys = new TreeSet<String>();
-
+
+      // Get the base bucket name from splitting the root path and removing the prefixed protocol and end-point
       String[] pathSplit = root.toString().split(File.separator);
-
       String bucketName =  pathSplit[2];
+
+      // Append the desired key onto the remaining prefix
       String key2 = root.toString().substring(root.toString().indexOf(pathSplit[3]), root.toString().length());
 
       ListObjectsRequest listObjectsRequest = new ListObjectsRequest()
@@ -249,11 +254,13 @@ private TreeSet<String> getKeysFor(String suffix) throws IOException {
 
     public ArrayList<String> getFiles() throws IOException {
       ArrayList<String> keys = new ArrayList<String>();
-
+
+      // Get the base bucket name from splitting the root path and removing the prefixed protocol and end-point
       String[] pathSplit = root.toString().split(File.separator);
       String bucketName =  pathSplit[2];
+
+      // Append the desired key onto the remaining prefix
       String key2 = root.toString().substring(root.toString().indexOf(pathSplit[3]), root.toString().length());
-
       ListObjectsRequest listObjectsRequest = new ListObjectsRequest()
           .withBucketName(bucketName)
           .withPrefix(key2)