From 7fff067a2d88c97f35da13471dd4aa0b4269b3d1 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Tue, 19 Oct 2021 15:19:19 -0400 Subject: [PATCH] 7673 documentation improvements --- .../autopsy/ingest/DataArtifactIngestTask.java | 6 +++--- .../autopsy/ingest/DataSourceIngestPipeline.java | 6 +++--- .../autopsy/ingest/DataSourceIngestTask.java | 14 +++++++------- .../autopsy/ingest/FileIngestPipeline.java | 2 +- .../sleuthkit/autopsy/ingest/FileIngestTask.java | 14 +++++++------- .../org/sleuthkit/autopsy/ingest/IngestTask.java | 2 +- 6 files changed, 22 insertions(+), 22 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/ingest/DataArtifactIngestTask.java b/Core/src/org/sleuthkit/autopsy/ingest/DataArtifactIngestTask.java index 4f0cad5679..2a43146ca5 100755 --- a/Core/src/org/sleuthkit/autopsy/ingest/DataArtifactIngestTask.java +++ b/Core/src/org/sleuthkit/autopsy/ingest/DataArtifactIngestTask.java @@ -22,7 +22,7 @@ import org.sleuthkit.datamodel.DataArtifact; /** * A data artifact ingest task that will be executed by an ingest thread using a - * given ingest job pipeline. + * given ingest job executor. */ final class DataArtifactIngestTask extends IngestTask { @@ -30,9 +30,9 @@ final class DataArtifactIngestTask extends IngestTask { /** * Constructs a data artifact ingest task that will be executed by an ingest - * thread using a given ingest job pipeline. + * thread using a given ingest job executor. * - * @param ingestJobExecutor The ingest job pipeline to use to execute the + * @param ingestJobExecutor The ingest job executor to use to execute the * task. * @param artifact The data artifact to be processed. */ diff --git a/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestPipeline.java b/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestPipeline.java index ac5615eb08..398b683b52 100644 --- a/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestPipeline.java +++ b/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestPipeline.java @@ -38,12 +38,12 @@ final class DataSourceIngestPipeline extends IngestPipeline moduleTemplates) { - super(ingestJobPipeline, moduleTemplates); + DataSourceIngestPipeline(IngestJobExecutor ingestJobExecutor, List moduleTemplates) { + super(ingestJobExecutor, moduleTemplates); } @Override diff --git a/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestTask.java b/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestTask.java index 4a73cd12d0..ddb1a7b471 100644 --- a/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestTask.java +++ b/Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestTask.java @@ -20,25 +20,25 @@ package org.sleuthkit.autopsy.ingest; /** * A data source level ingest task that will be executed by an ingest thread - * using a given ingest job pipeline. + * using a given ingest job executor. */ final class DataSourceIngestTask extends IngestTask { /** * Constructs a data source level ingest task that will be executed by an - * ingest thread using a given ingest job pipeline. + * ingest thread using a given ingest job executor. * - * @param ingestJobPipeline The ingest job pipeline to use to execute the + * @param ingestJobExecutor The ingest job executor to use to execute the * task. */ - DataSourceIngestTask(IngestJobExecutor ingestJobPipeline) { - super(ingestJobPipeline); + DataSourceIngestTask(IngestJobExecutor ingestJobExecutor) { + super(ingestJobExecutor); } @Override void execute(long threadId) { super.setThreadId(threadId); getIngestJobExecutor().execute(this); - } - + } + } diff --git a/Core/src/org/sleuthkit/autopsy/ingest/FileIngestPipeline.java b/Core/src/org/sleuthkit/autopsy/ingest/FileIngestPipeline.java index 9c7bf8fc2c..f175150fd1 100644 --- a/Core/src/org/sleuthkit/autopsy/ingest/FileIngestPipeline.java +++ b/Core/src/org/sleuthkit/autopsy/ingest/FileIngestPipeline.java @@ -52,7 +52,7 @@ final class FileIngestPipeline extends IngestPipeline { * Constructs a pipeline of file ingest modules for executing file ingest * tasks for an ingest job. * - * @param ingestJobPipeline The ingest job pipeline that owns this pipeline. + * @param ingestJobPipeline The ingest job executor that owns this pipeline. * @param moduleTemplates The ingest module templates that define this * pipeline. */ diff --git a/Core/src/org/sleuthkit/autopsy/ingest/FileIngestTask.java b/Core/src/org/sleuthkit/autopsy/ingest/FileIngestTask.java index 50a783b6c1..63bf99dfc4 100644 --- a/Core/src/org/sleuthkit/autopsy/ingest/FileIngestTask.java +++ b/Core/src/org/sleuthkit/autopsy/ingest/FileIngestTask.java @@ -25,7 +25,7 @@ import org.sleuthkit.datamodel.TskCoreException; /** * A file ingest task that will be executed by an ingest thread using a given - * ingest job pipeline. + * ingest job executor. */ final class FileIngestTask extends IngestTask { @@ -34,9 +34,9 @@ final class FileIngestTask extends IngestTask { /** * Constructs a file ingest task that will be executed by an ingest thread - * using a given ingest job pipeline. + * using a given ingest job executor. * - * @param ingestJobPipeline The ingest job pipeline to use to execute the + * @param ingestJobPipeline The ingest job executor to use to execute the * task. * @param file The file to be processed. */ @@ -48,11 +48,11 @@ final class FileIngestTask extends IngestTask { /** * Constructs a file ingest task that will be executed by an ingest thread - * using a given ingest job pipeline. This constructor supports streaming + * using a given ingest job executor. This constructor supports streaming * ingest by deferring the construction of the AbstractFile object for this * task to conserve heap memory. * - * @param ingestJobPipeline The ingest job pipeline to use to execute the + * @param ingestJobPipeline The ingest job executor to use to execute the * task. * @param fileId The object ID of the file to be processed. */ @@ -105,14 +105,14 @@ final class FileIngestTask extends IngestTask { if (thisPipeline != otherPipeline && (thisPipeline == null || !thisPipeline.equals(otherPipeline))) { return false; } - return (this.fileId == other.fileId); + return (getFileId() == other.getFileId()); } @Override public int hashCode() { int hash = 5; hash = 47 * hash + Objects.hashCode(getIngestJobExecutor()); - hash = 47 * hash + Objects.hashCode(this.fileId); + hash = 47 * hash + Objects.hashCode(getFileId()); return hash; } diff --git a/Core/src/org/sleuthkit/autopsy/ingest/IngestTask.java b/Core/src/org/sleuthkit/autopsy/ingest/IngestTask.java index bbbbcad348..fcca0dc629 100644 --- a/Core/src/org/sleuthkit/autopsy/ingest/IngestTask.java +++ b/Core/src/org/sleuthkit/autopsy/ingest/IngestTask.java @@ -47,7 +47,7 @@ abstract class IngestTask { /** * Gets the ingest job executor to use to execute this task. * - * @return The ingest job pipeline. + * @return The ingest job executor. */ IngestJobExecutor getIngestJobExecutor() { return ingestJobExecutor;