Skip to content
Snippets Groups Projects
Commit f96daafc authored by Nils Christian Ehmke's avatar Nils Christian Ehmke
Browse files

Added some comments

parent f02fc168
No related branches found
No related tags found
No related merge requests found
......@@ -17,7 +17,7 @@
package kieker.gui.common.domain;
/**
* This enumeration shows the available statistics (and their datatype) which can be added for example to traces or operation calls.
* This enumeration shows the available statistics (and their datatype) which can be added for example to traces or operation calls.
*
* @author Nils Christian Ehmke
*/
......
......@@ -19,6 +19,16 @@ package kieker.gui.common.model.importer.stages;
import teetime.framework.AbstractConsumerStage;
import teetime.framework.OutputPort;
/**
* This is a abstract base for {@code TeeTime} stages with exactly one input and one output port.
*
* @author Nils Christian Ehmke
*
* @param <I>
* The type of the input port.
* @param <O>
* The type of the output port.
*/
public abstract class AbstractStage<I, O> extends AbstractConsumerStage<I> {
private final OutputPort<O> outputPort = super.createOutputPort();
......
......@@ -18,6 +18,14 @@ package kieker.gui.common.model.importer.stages;
import kieker.gui.common.domain.AbstractTrace;
/**
* This stage filters incoming traces and forwards only those which are failed.
*
* @author Nils Christian Ehmke
*
* @param <T>
* The precise type of the incoming and outgoing traces.
*/
public final class FailedTraceFilter<T extends AbstractTrace> extends AbstractStage<T, T> {
@Override
......
......@@ -18,6 +18,14 @@ package kieker.gui.common.model.importer.stages;
import kieker.gui.common.domain.AbstractTrace;
/**
* This stage filters incoming traces and forwards only those which are failed or contain a failure in the call tree.
*
* @author Nils Christian Ehmke
*
* @param <T>
* The precise type of the incoming and outgoing traces.
*/
public final class FailureContainingTraceFilter<T extends AbstractTrace> extends AbstractStage<T, T> {
@Override
......
......@@ -34,6 +34,11 @@ import teetime.stage.InitialElementProducer;
import teetime.stage.className.ClassNameRegistryRepository;
import teetime.stage.io.filesystem.Dir2RecordsFilter;
/**
* This is a composite stage which deserializes monitoring records from a specific directory and forwards them to the output port.
*
* @author Nils Christian Ehmke
*/
public final class ReadingComposite extends Stage {
private final InitialElementProducer<File> producer;
......
......@@ -25,7 +25,7 @@ import kieker.gui.common.domain.AggregatedTrace;
import kieker.gui.common.domain.Trace;
/**
* Aggregates incoming traces into trace equivalence classes.
* This stage aggregates incoming traces into trace equivalence classes.
*
* @author Nils Christian Ehmke
*/
......
......@@ -31,8 +31,8 @@ import kieker.gui.common.domain.OperationCall;
import kieker.gui.common.domain.Trace;
/**
* Reconstruct traces based on the incoming instances of {@code IFlowRecord}. Currently only {@link TraceMetadata}, {@link BeforeOperationEvent} and
* {@link AfterOperationEvent} instances are supported.
* Reconstruct traces based on the incoming instances of {@code IFlowRecord}. Currently only {@link TraceMetadata}, {@link BeforeOperationEvent} and {@link AfterOperationEvent}
* instances are supported.
*
* @author Nils Christian Ehmke
*/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment