mstoeck3/autopsy-flatpak
1
0
Fork 0
mirror of https://github.com/overcuriousity/autopsy-flatpak.git synced 2025-07-13 08:26: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:00:52 -04:00
parent 0c1a44ca2f
commit a8d8c27692
2 changed files with 13 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Core/src/org/sleuthkit/autopsy/ingest/DataArtifactIngestPipeline.java
View File

@ -23,22 +23,23 @@ import java.util.Optional;
import org.sleuthkit.datamodel.DataArtifact; import org.sleuthkit.datamodel.DataArtifact;
/** /**
* A pipeline of data artifact ingest modules used to execute data artifact * A pipeline of data artifact ingest modules used to perform data artifact
* ingest tasks for an ingest job. * ingest tasks for an ingest job.
*/ */
final class DataArtifactIngestPipeline extends IngestPipeline<DataArtifactIngestTask> { final class DataArtifactIngestPipeline extends IngestPipeline<DataArtifactIngestTask> {
/** /**
* Constructs a pipeline of data artifact ingest modules used to execute * Constructs a pipeline of data artifact ingest modules used to perform
* data artifact ingest tasks for an ingest job. * data artifact ingest tasks for an ingest job.
* *
* @param ingestJobPipeline The ingest job pipeline that owns this ingest * @param ingestJobExecutor The ingest job executor that owns this pipeline.
* task pipeline. * @param moduleTemplates The ingest module templates to be used to
* @param moduleTemplates The ingest module templates that define this * construct the ingest modules for this pipeline.
* pipeline. May be an empty list. * May be an empty list if this type of pipeline is
* not needed for the ingest job.
*/ */
DataArtifactIngestPipeline(IngestJobExecutor ingestJobPipeline, List<IngestModuleTemplate> moduleTemplates) { DataArtifactIngestPipeline(IngestJobExecutor ingestJobExecutor, List<IngestModuleTemplate> moduleTemplates) {
super(ingestJobPipeline, moduleTemplates); super(ingestJobExecutor, moduleTemplates);
} }
@Override @Override

11
Core/src/org/sleuthkit/autopsy/ingest/IngestPipeline.java
View File

@ -355,10 +355,7 @@ abstract class IngestPipeline<T extends IngestTask> {
/** /**
* An abstract superclass for an ingest module decorator that adds ingest * An abstract superclass for an ingest module decorator that adds ingest
* infrastructure operations to the process() method of an ingest module. * infrastructure operations to an ingest module.
* Subclasses of IngestPipeline need to provide a concrete implementation of
* this class that provides the additional operations that the pipeline
* requires.
*/ */
static abstract class PipelineModule<T extends IngestTask> implements IngestModule { static abstract class PipelineModule<T extends IngestTask> implements IngestModule {
@ -368,10 +365,10 @@ abstract class IngestPipeline<T extends IngestTask> {
/** /**
* Constructs an instance of an abstract superclass for an ingest module * Constructs an instance of an abstract superclass for an ingest module
* decorator that adds ingest infrastructure operations to the process() * decorator that adds ingest infrastructure operations to an ingest
* method of an ingest module. * module.
* *
* @param module The ingest module to be wrapped. * @param module The ingest module to be decorated.
* @param displayName The display name for the module. * @param displayName The display name for the module.
*/ */
PipelineModule(IngestModule module, String displayName) { PipelineModule(IngestModule module, String displayName) {