diff --git a/src/main/java/kieker/analysis/plugin/filter/sink/CPUUtilizationDisplayFilter.java b/src/main/java/kieker/analysis/plugin/filter/sink/CPUUtilizationDisplayFilter.java index bc1bf3d73ecc8e82ec42296d52be17c1ae55e7f0..ea885996d14b3a1480b4aa26c932eabd4f36ee51 100644 --- a/src/main/java/kieker/analysis/plugin/filter/sink/CPUUtilizationDisplayFilter.java +++ b/src/main/java/kieker/analysis/plugin/filter/sink/CPUUtilizationDisplayFilter.java @@ -28,7 +28,7 @@ import kieker.common.record.system.CPUUtilizationRecord; import teetime.stage.basic.AbstractFilter; /** - * This is a filter which accepts {@link CPUUtilizationRecord} instances and provides different views to visualize them. + * This is a filter which accepts {@link CPUUtilizationRecord} instances and provides different views (XYPlot or MeterGauge) to visualize them. * * @author Bjoern Weissenfels, Nils Christian Ehmke, Lars Erik Bluemke * @@ -51,7 +51,19 @@ public class CPUUtilizationDisplayFilter extends AbstractFilter<CPUUtilizationRe private final TimeUnit recordsTimeUnit; - public CPUUtilizationDisplayFilter(final int numberOfEntries, final Long[] warningIntervals, final TimeUnit recordsTimeUnit) { + /** + * Creates a new instance of this filter. + * + * @param numberOfEntries + * Maximal number of entries in a XYPlot + * @param warningIntervals + * The intervals for the colors displayed in a XYPlot + * @param recordsTimeUnit + * Time unit to interpret the timestamp of a record passed to the input port + * @see kieker.analysis.display.MeterGauge + * @see kieker.analysis.display.XYPlot + */ + public CPUUtilizationDisplayFilter(final int numberOfEntries, final Number[] warningIntervals, final TimeUnit recordsTimeUnit) { this.numberOfEntries = numberOfEntries; this.warningIntervals = warningIntervals; this.recordsTimeUnit = recordsTimeUnit;