Format IngestManager.java

This commit is contained in:
Richard Cordovano 2021-03-18 16:47:34 -04:00
parent 28afde7d53
commit dd6d35c6b4

View File

@ -287,15 +287,16 @@ public class IngestManager implements IngestProgressSnapshotProvider {
caseIsOpen = false;
clearIngestMessageBox();
}
/**
* Creates an ingest stream from the given ingest settings for a data source.
*
* Creates an ingest stream from the given ingest settings for a data
* source.
*
* @param dataSource The data source
* @param settings The ingest job settings.
*
*
* @return The newly created ingest stream.
*
*
* @throws TskCoreException if there was an error starting the ingest job.
*/
public IngestStream openIngestStream(DataSource dataSource, IngestJobSettings settings) throws TskCoreException {
@ -313,7 +314,6 @@ public class IngestManager implements IngestProgressSnapshotProvider {
}
}
/**
* Gets the number of file ingest threads the ingest manager is using to do
* ingest jobs.
@ -519,10 +519,11 @@ public class IngestManager implements IngestProgressSnapshotProvider {
public void addIngestJobEventListener(final PropertyChangeListener listener) {
jobEventPublisher.addSubscriber(INGEST_JOB_EVENT_NAMES, listener);
}
/**
* Adds an ingest job event property change listener for the given event types.
*
* Adds an ingest job event property change listener for the given event
* types.
*
* @param eventTypes The event types to listen for
* @param listener The PropertyChangeListener to be added
*/
@ -540,18 +541,18 @@ public class IngestManager implements IngestProgressSnapshotProvider {
public void removeIngestJobEventListener(final PropertyChangeListener listener) {
jobEventPublisher.removeSubscriber(INGEST_JOB_EVENT_NAMES, listener);
}
/**
* Removes an ingest job event property change listener.
*
* @param eventTypes The event types to stop listening for
* @param listener The PropertyChangeListener to be removed.
* @param listener The PropertyChangeListener to be removed.
*/
public void removeIngestJobEventListener(Set<IngestJobEvent> eventTypes, final PropertyChangeListener listener) {
eventTypes.forEach((IngestJobEvent event) -> {
jobEventPublisher.removeSubscriber(event.toString(), listener);
});
}
}
/**
* Adds an ingest module event property change listener.
@ -563,8 +564,9 @@ public class IngestManager implements IngestProgressSnapshotProvider {
}
/**
* Adds an ingest module event property change listener for given event types.
*
* Adds an ingest module event property change listener for given event
* types.
*
* @param eventTypes The event types to listen for
* @param listener The PropertyChangeListener to be removed.
*/
@ -573,7 +575,7 @@ public class IngestManager implements IngestProgressSnapshotProvider {
moduleEventPublisher.addSubscriber(event.toString(), listener);
});
}
/**
* Removes an ingest module event property change listener.
*
@ -582,16 +584,16 @@ public class IngestManager implements IngestProgressSnapshotProvider {
public void removeIngestModuleEventListener(final PropertyChangeListener listener) {
moduleEventPublisher.removeSubscriber(INGEST_MODULE_EVENT_NAMES, listener);
}
/**
* Removes an ingest module event property change listener.
*
*
* @param eventTypes The event types to stop listening for
* @param listener The PropertyChangeListener to be removed.
*/
public void removeIngestModuleEventListener(Set<IngestModuleEvent> eventTypes, final PropertyChangeListener listener) {
moduleEventPublisher.removeSubscriber(INGEST_MODULE_EVENT_NAMES, listener);
}
}
/**
* Publishes an ingest job event signifying an ingest job started.