Add a couple of TODOs

apache · Jan 19, 2022 · ac6d276 · ac6d276
1 parent 093890c
commit ac6d276
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java b/commons-vfs2/src/main/java/org/apache/commons/vfs2/provider/AbstractFileObject.java
@@ -1228,6 +1228,7 @@ public FileName getName() {
         return fileName;
     }
 
+    // TODO: remove this method for the next major version as it is unused
     /**
      * Prepares this file for writing. Makes sure it is either a file, or its parent folder exists. Returns an output
      * stream to use to write the content of the file to.
@@ -1239,6 +1240,8 @@ public OutputStream getOutputStream() throws FileSystemException {
         return getOutputStream(false);
     }
 
+    // TODO: mark this method as `final` and package-private for the next major version because
+    // it shouldn't be used from anywhere other than `DefaultFileContent`
     /**
      * Prepares this file for writing. Makes sure it is either a file, or its parent folder exists. Returns an output
      * stream to use to write the content of the file to.