Skip to content

Ghidra is a software reverse engineering (SRE) framework

GP-5640: Fixing GFileSystem iterable function javadoc

Ryan Kurtzcc1fea856276
diff --git a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java
index 50125e7b2a..2e55e3755b 100644
--- a/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java
+++ b/Ghidra/Features/Base/src/main/java/ghidra/formats/gfilesystem/GFileSystem.java
@@ -255,38 +255,38 @@ public interface GFileSystem extends Closeable, Iterable<GFile>, ExtensionPoint
}
/**
- * Gets an {@link Iterator} over this {@link GFileSystem}'s {@link GFile files}.
+ * Gets an {@link Iterable} over this {@link GFileSystem}'s {@link GFile files}.
*
* @return An {@link Iterable} over this {@link GFileSystem}'s {@link GFile files}.
*/
- default Iterable<GFile> files() {
+ public default Iterable<GFile> files() {
return () -> new GFileSystemIterator(this);
}
/**
- * Gets an {@link Iterator} over this {@link GFileSystem}'s {@link GFile files}.
+ * Gets an {@link Iterable} over this {@link GFileSystem}'s {@link GFile files}.
*
* @param dir The {@link GFile directory} to start iterating at in this {@link GFileSystem}. If
* {@code null}, iteration will start at the root of the {@link GFileSystem}.
* @throws UncheckedIOException if {@code dir} is not a directory
* @return An {@link Iterable} over this {@link GFileSystem}'s {@link GFile files}.
*/
- default Iterable<GFile> files(GFile dir) throws UncheckedIOException {
+ public default Iterable<GFile> files(GFile dir) throws UncheckedIOException {
return () -> new GFileSystemIterator(Objects.requireNonNullElse(dir, getRootDir()));
}
/**
- * Gets an {@link Iterator} over this {@link GFileSystem}'s {@link GFile files}.
+ * Gets an {@link Iterable} over this {@link GFileSystem}'s {@link GFile files}.
*
* @param fileFilter A filter to apply to the {@link GFile files} iterated over
* @return An {@link Iterable} over this {@link GFileSystem}'s {@link GFile files}.
*/
- default Iterable<GFile> files(Predicate<GFile> fileFilter) {
+ public default Iterable<GFile> files(Predicate<GFile> fileFilter) {
return () -> new GFileSystemIterator(getRootDir(), fileFilter);
}
/**
- * Gets an {@link Iterator} over this {@link GFileSystem}'s {@link GFile files}.
+ * Gets an {@link Iterable} over this {@link GFileSystem}'s {@link GFile files}.
*
* @param dir The {@link GFile directory} to start iterating at in this {@link GFileSystem}. If
* {@code null}, iteration will start at the root of the {@link GFileSystem}.
@@ -294,7 +294,7 @@ public interface GFileSystem extends Closeable, Iterable<GFile>, ExtensionPoint
* @throws UncheckedIOException if {@code dir} is not a directory
* @return An {@link Iterable} over this {@link GFileSystem}'s {@link GFile files}.
*/
- default Iterable<GFile> files(GFile dir, Predicate<GFile> fileFilter)
+ public default Iterable<GFile> files(GFile dir, Predicate<GFile> fileFilter)
throws UncheckedIOException {
return () -> new GFileSystemIterator(Objects.requireNonNullElse(dir, getRootDir()),
fileFilter);