From d924c2157745e41fe75b6bd688ad3a928bc2dd2e Mon Sep 17 00:00:00 2001
From: Brian Carrier <carrier@sleuthkit.org>
Date: Wed, 14 Aug 2013 23:36:25 -0400
Subject: [PATCH] comment updates to java
---
API-CHANGES.txt | 1 +
.../org/sleuthkit/datamodel/SleuthkitCase.java | 18 +++++++++---------
2 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/API-CHANGES.txt b/API-CHANGES.txt
index d008b21af..8283f9eaf 100644
--- a/API-CHANGES.txt
+++ b/API-CHANGES.txt
@@ -2,3 +2,4 @@ Changes to make once we are ready to do a backwards incompatible change.
- TSK_SERVICE_ACCOUNT to TSK_ACCOUNT
- HashDB to use new TSK_BASE_HASHDB enum instead of its own ENUM
- Java SLeuthkitCase.addArtifactType shoudl return different if artifact already exists or getArtifactId should....
+- Java SleuthkitCase.findFilesWhere should return AbstractFile liek findFiles
diff --git a/bindings/java/src/org/sleuthkit/datamodel/SleuthkitCase.java b/bindings/java/src/org/sleuthkit/datamodel/SleuthkitCase.java
index 5fc5b0ce1..70bba59ae 100644
--- a/bindings/java/src/org/sleuthkit/datamodel/SleuthkitCase.java
+++ b/bindings/java/src/org/sleuthkit/datamodel/SleuthkitCase.java
@@ -2716,8 +2716,8 @@ else if (dataSource instanceof VirtualDirectory) {
/**
* @param dataSource the dataSource (Image, parent-less VirtualDirectory) to search for the given file name
- * @param fileName the name of the file or directory to match (case
- * insensitive)
+ * @param fileName Pattern of the name of the file or directory to match (case
+ * insensitive, used in LIKE SQL statement).
* @return a list of AbstractFile for files/directories whose name matches the
* given fileName
* @throws TskCoreException thrown if check failed
@@ -2780,10 +2780,10 @@ public List<AbstractFile> findFiles(Content dataSource, String fileName) throws
/**
* @param dataSource the dataSource (Image, parent-less VirtualDirectory) to search for the given file name
- * @param fileName the name of the file or directory to match (case
- * insensitive)
- * @param dirName the name of a parent directory of fileName (case
- * insensitive)
+ * @param fileName Pattern of the name of the file or directory to match (case
+ * insensitive, used in LIKE SQL statement).
+ * @param dirName Pattern of the name of a parent directory of fileName (case
+ * insensitive, used in LIKE SQL statement)
* @return a list of AbstractFile for files/directories whose name matches
* fileName and whose parent directory contains dirName.
*/
@@ -3547,9 +3547,9 @@ public LocalFile addLocalFile(String fileName, String localPath,
/**
* Find all files in the data source, by name and parent
* @param dataSource the dataSource (Image, parent-less VirtualDirectory) to search for the given file name
- * @param fileName the name of the file or directory to match (case
- * insensitive)
- * @param parentFile
+ * @param fileName Pattern of the name of the file or directory to match (case
+ * insensitive, used in LIKE SQL statement).
+ * @param parentFile Object for parent file/directory to find children in
* @return a list of AbstractFile for files/directories whose name matches
* fileName and that were inside a directory described by parentFile.
*/
--
GitLab