From 7a1c20fc481eab31a2f67923bfeb2b0c1a6513f5 Mon Sep 17 00:00:00 2001
From: Harald Musum <musum@yahooinc.com>
Date: Sun, 15 Oct 2023 20:01:33 +0200
Subject: Use actual files in application package to validate file/directory in
 user config

---
 .../config/application/api/ApplicationFile.java    | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

(limited to 'config-model-api')

diff --git a/config-model-api/src/main/java/com/yahoo/config/application/api/ApplicationFile.java b/config-model-api/src/main/java/com/yahoo/config/application/api/ApplicationFile.java
index 36d6efdf59b..d262c7bc862 100644
--- a/config-model-api/src/main/java/com/yahoo/config/application/api/ApplicationFile.java
+++ b/config-model-api/src/main/java/com/yahoo/config/application/api/ApplicationFile.java
@@ -27,21 +27,21 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
     }
 
     /**
-     * Check whether or not this file is a directory.
+     * Checks whether this file is a directory.
      *
      * @return true if it is, false if not.
      */
     public abstract boolean isDirectory();
 
     /**
-     * Test whether or not this file exists.
+     * Tests whether this file exists.
      *
      * @return true if it exists, false if not.
      */
     public abstract boolean exists();
 
     /**
-     * Create a {@link Reader} for the contents of this file.
+     * Creates a {@link Reader} for the contents of this file.
      *
      * @return A {@link Reader} that should be closed after use.
      * @throws FileNotFoundException if the file is not found.
@@ -50,7 +50,7 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
 
 
     /**
-     * Create an {@link InputStream} for the contents of this file.
+     * Creates an {@link InputStream} for the contents of this file.
      *
      * @return An {@link InputStream} that should be closed after use.
      * @throws FileNotFoundException if the file is not found.
@@ -58,7 +58,7 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
     public abstract InputStream createInputStream() throws FileNotFoundException;
 
     /**
-     * Create a directory at the path represented by this file. Parent directories will
+     * Creates a directory at the path represented by this file. Parent directories will
      * be automatically created.
      *
      * @return this
@@ -67,7 +67,7 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
     public abstract ApplicationFile createDirectory();
 
     /**
-     * Write the contents from this reader to this file. Any existing content will be overwritten!
+     * Writes the contents from supplied reader to this file. Any existing content will be overwritten!
      *
      * @param input A reader pointing to the content that should be written.
      * @return this
@@ -82,7 +82,7 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
     public abstract ApplicationFile appendFile(String value);
 
     /**
-     * List the files under this directory. If this is file, an empty list is returned.
+     * Lists the files under this directory. If this is file, an empty list is returned.
      * Only immediate files/subdirectories are returned.
      *
      * @return a list of files in this directory.
@@ -92,7 +92,7 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
     }
 
     /**
-     * List the files under this directory. If this is file, an empty list is returned.
+     * Lists the files under this directory. If this is a file, an empty list is returned.
      * Only immediate files/subdirectories are returned.
      *
      * @param filter A filter functor for filtering path names
@@ -101,7 +101,7 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
     public abstract List<ApplicationFile> listFiles(PathFilter filter);
 
     /**
-     * List the files in this directory, optionally list files for subdirectories recursively as well.
+     * Lists the files in this directory, optionally lists files for subdirectories recursively as well.
      *
      * @param recurse Set to true if all files in the directory tree should be returned.
      * @return a list of files in this directory.
@@ -121,7 +121,7 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
     }
 
     /**
-     * Delete the file pointed to by this. If it is a non-empty directory, the operation will throw.
+     * Deletes the file pointed to by this. If this is a non-empty directory, the operation will throw.
      *
      * @return this.
      * @throws RuntimeException if the file is a directory and not empty.
@@ -129,7 +129,7 @@ public abstract class ApplicationFile implements Comparable<ApplicationFile> {
     public abstract ApplicationFile delete();
 
     /**
-     * Get the path that this file represents.
+     * Gets the path that this file represents.
      *
      * @return a Path
      */
-- 
cgit v1.2.3