7673 documentation improvements

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

View File

@ -23,22 +23,23 @@ import java.util.Optional;
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.
*/
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.
*
* @param ingestJobPipeline The ingest job pipeline that owns this ingest
* task pipeline.
* @param moduleTemplates The ingest module templates that define this
* pipeline. May be an empty list.
* @param ingestJobExecutor The ingest job executor that owns this pipeline.
* @param moduleTemplates The ingest module templates to be used to
* construct the ingest modules for this pipeline.
* May be an empty list if this type of pipeline is
* not needed for the ingest job.
*/
DataArtifactIngestPipeline(IngestJobExecutor ingestJobPipeline, List<IngestModuleTemplate> moduleTemplates) {
super(ingestJobPipeline, moduleTemplates);
DataArtifactIngestPipeline(IngestJobExecutor ingestJobExecutor, List<IngestModuleTemplate> moduleTemplates) {
super(ingestJobExecutor, moduleTemplates);
}
@Override

View File

@ -355,10 +355,7 @@ abstract class IngestPipeline<T extends IngestTask> {
/**
* An abstract superclass for an ingest module decorator that adds ingest
* infrastructure operations to the process() method of an ingest module.
* Subclasses of IngestPipeline need to provide a concrete implementation of
* this class that provides the additional operations that the pipeline
* requires.
* infrastructure operations to an ingest module.
*/
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
* decorator that adds ingest infrastructure operations to the process()
* method of an ingest module.
* decorator that adds ingest infrastructure operations to an ingest
* 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.
*/
PipelineModule(IngestModule module, String displayName) {