mstoeck3/autopsy-flatpak
1
0
Fork 0
mirror of https://github.com/overcuriousity/autopsy-flatpak.git synced 2025-07-12 16:06:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

7673 documentation improvements

Browse Source
This commit is contained in:
Richard Cordovano 2021-10-19 15:19:19 -04:00
parent 4d795e8869
commit 7fff067a2d
6 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Core/src/org/sleuthkit/autopsy/ingest/DataArtifactIngestTask.java
View File

@ -22,7 +22,7 @@ import org.sleuthkit.datamodel.DataArtifact;
/** /**
* A data artifact ingest task that will be executed by an ingest thread using a * 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 { 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 * 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. * task.
* @param artifact The data artifact to be processed. * @param artifact The data artifact to be processed.
*/ */

6
Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestPipeline.java
View File

@ -38,12 +38,12 @@ final class DataSourceIngestPipeline extends IngestPipeline<DataSourceIngestTask
* Constructs a pipeline of data source level ingest modules for performing * Constructs a pipeline of data source level ingest modules for performing
* data source level ingest tasks for an ingest job. * data source level ingest tasks for an ingest job.
* *
* @param ingestJobPipeline The ingest job pipeline that owns this pipeline. * @param ingestJobExecutor The ingest job executor that owns this pipeline.
* @param moduleTemplates The ingest module templates that define this * @param moduleTemplates The ingest module templates that define this
* pipeline. * pipeline.
*/ */
DataSourceIngestPipeline(IngestJobExecutor ingestJobPipeline, List<IngestModuleTemplate> moduleTemplates) { DataSourceIngestPipeline(IngestJobExecutor ingestJobExecutor, List<IngestModuleTemplate> moduleTemplates) {
super(ingestJobPipeline, moduleTemplates); super(ingestJobExecutor, moduleTemplates);
} }
@Override @Override

10
Core/src/org/sleuthkit/autopsy/ingest/DataSourceIngestTask.java
View File

@ -20,19 +20,19 @@ package org.sleuthkit.autopsy.ingest;
/** /**
* A data source level ingest task that will be executed by an ingest thread * 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 { final class DataSourceIngestTask extends IngestTask {
/** /**
* Constructs a data source level ingest task that will be executed by an * 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. * task.
*/ */
DataSourceIngestTask(IngestJobExecutor ingestJobPipeline) { DataSourceIngestTask(IngestJobExecutor ingestJobExecutor) {
super(ingestJobPipeline); super(ingestJobExecutor);
} }
@Override @Override

2
Core/src/org/sleuthkit/autopsy/ingest/FileIngestPipeline.java
View File

@ -52,7 +52,7 @@ final class FileIngestPipeline extends IngestPipeline<FileIngestTask> {
* Constructs a pipeline of file ingest modules for executing file ingest * Constructs a pipeline of file ingest modules for executing file ingest
* tasks for an ingest job. * 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 * @param moduleTemplates The ingest module templates that define this
* pipeline. * pipeline.
*/ */

14
Core/src/org/sleuthkit/autopsy/ingest/FileIngestTask.java
View File

@ -25,7 +25,7 @@ import org.sleuthkit.datamodel.TskCoreException;
/** /**
* A file ingest task that will be executed by an ingest thread using a given * 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 { 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 * 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. * task.
* @param file The file to be processed. * @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 * 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 * ingest by deferring the construction of the AbstractFile object for this
* task to conserve heap memory. * 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. * task.
* @param fileId The object ID of the file to be processed. * @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))) { if (thisPipeline != otherPipeline && (thisPipeline == null || !thisPipeline.equals(otherPipeline))) {
return false; return false;
} }
return (this.fileId == other.fileId); return (getFileId() == other.getFileId());
} }
@Override @Override
public int hashCode() { public int hashCode() {
int hash = 5; int hash = 5;
hash = 47 * hash + Objects.hashCode(getIngestJobExecutor()); hash = 47 * hash + Objects.hashCode(getIngestJobExecutor());
hash = 47 * hash + Objects.hashCode(this.fileId); hash = 47 * hash + Objects.hashCode(getFileId());
return hash; return hash;
} }

2
Core/src/org/sleuthkit/autopsy/ingest/IngestTask.java
View File

@ -47,7 +47,7 @@ abstract class IngestTask {
/** /**
* Gets the ingest job executor to use to execute this task. * Gets the ingest job executor to use to execute this task.
* *
* @return The ingest job pipeline. * @return The ingest job executor.
*/ */
IngestJobExecutor getIngestJobExecutor() { IngestJobExecutor getIngestJobExecutor() {
return ingestJobExecutor; return ingestJobExecutor;