From fdaa80126fe0c1812cc12166b58cf7bb6a1d0039 Mon Sep 17 00:00:00 2001 From: "M.Schmidt" Date: Tue, 21 Jan 2025 14:48:20 +0100 Subject: [PATCH] add doc --- .../java/sootup/core/inputlocation/AnalysisInputLocation.java | 2 +- .../inputlocation/ArchiveBasedAnalysisInputLocation.java | 1 + .../frontend/inputlocation/PathBasedAnalysisInputLocation.java | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/sootup.core/src/main/java/sootup/core/inputlocation/AnalysisInputLocation.java b/sootup.core/src/main/java/sootup/core/inputlocation/AnalysisInputLocation.java index aecc5648ae..a26868901e 100644 --- a/sootup.core/src/main/java/sootup/core/inputlocation/AnalysisInputLocation.java +++ b/sootup.core/src/main/java/sootup/core/inputlocation/AnalysisInputLocation.java @@ -58,7 +58,7 @@ public interface AnalysisInputLocation { /** * Scan the input location and create ClassSources for every compilation / interpretation unit. * - * @return The source entries. + * @return an Autocloseable resource that must be closed! */ @Nonnull Stream getClassSources(@Nonnull View view); diff --git a/sootup.java.bytecode.frontend/src/main/java/sootup/java/bytecode/frontend/inputlocation/ArchiveBasedAnalysisInputLocation.java b/sootup.java.bytecode.frontend/src/main/java/sootup/java/bytecode/frontend/inputlocation/ArchiveBasedAnalysisInputLocation.java index b698c5bb7c..01f5978ae8 100644 --- a/sootup.java.bytecode.frontend/src/main/java/sootup/java/bytecode/frontend/inputlocation/ArchiveBasedAnalysisInputLocation.java +++ b/sootup.java.bytecode.frontend/src/main/java/sootup/java/bytecode/frontend/inputlocation/ArchiveBasedAnalysisInputLocation.java @@ -108,6 +108,7 @@ public Optional getClassSource(@Nonnull ClassType type, @No } } + /** returns a Autocloseable resource that must be closed! */ @Override @Nonnull public Stream getClassSources(@Nonnull View view) { diff --git a/sootup.java.bytecode.frontend/src/main/java/sootup/java/bytecode/frontend/inputlocation/PathBasedAnalysisInputLocation.java b/sootup.java.bytecode.frontend/src/main/java/sootup/java/bytecode/frontend/inputlocation/PathBasedAnalysisInputLocation.java index dbd61a9a06..6b26916616 100644 --- a/sootup.java.bytecode.frontend/src/main/java/sootup/java/bytecode/frontend/inputlocation/PathBasedAnalysisInputLocation.java +++ b/sootup.java.bytecode.frontend/src/main/java/sootup/java/bytecode/frontend/inputlocation/PathBasedAnalysisInputLocation.java @@ -141,7 +141,7 @@ public static PathBasedAnalysisInputLocation create( + "' has to be pointing to the root of a class container, e.g. directory, jar, zip, apk, war etc."); } - /** returns a resource that must be closed! */ + /** returns a Autocloseable resource that must be closed! */ @Nonnull protected Stream walkDirectory( @Nonnull Path dirPath,