diff options
| author | Marc R. Hoffmann <hoffmann@mountainminds.com> | 2010-10-15 11:21:42 +0000 |
|---|---|---|
| committer | Marc R. Hoffmann <hoffmann@mountainminds.com> | 2010-10-15 11:21:42 +0000 |
| commit | bb18678e1149389693c6051e9c3e5b8e6a5cd164 (patch) | |
| tree | c1e738f24e121492befae6920d50d0ca5908fc97 /org.jacoco.report/src/org/jacoco/report/internal/html/table/IColumnRenderer.java | |
| parent | 8365e5e16da12b592e560b0c340e7190f18fd6ca (diff) | |
| download | platform_external_jacoco-bb18678e1149389693c6051e9c3e5b8e6a5cd164.tar.gz platform_external_jacoco-bb18678e1149389693c6051e9c3e5b8e6a5cd164.tar.bz2 platform_external_jacoco-bb18678e1149389693c6051e9c3e5b8e6a5cd164.zip | |
Rename implementation packages to 'internal' and exclude them from generated JavaDoc. User Java 5 style package-info.java instead of package.html.
Diffstat (limited to 'org.jacoco.report/src/org/jacoco/report/internal/html/table/IColumnRenderer.java')
| -rw-r--r-- | org.jacoco.report/src/org/jacoco/report/internal/html/table/IColumnRenderer.java | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/org.jacoco.report/src/org/jacoco/report/internal/html/table/IColumnRenderer.java b/org.jacoco.report/src/org/jacoco/report/internal/html/table/IColumnRenderer.java new file mode 100644 index 00000000..34db7153 --- /dev/null +++ b/org.jacoco.report/src/org/jacoco/report/internal/html/table/IColumnRenderer.java @@ -0,0 +1,85 @@ +/*******************************************************************************
+ * Copyright (c) 2009, 2010 Mountainminds GmbH & Co. KG and Contributors
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Marc R. Hoffmann - initial API and implementation
+ *
+ *******************************************************************************/
+package org.jacoco.report.internal.html.table;
+
+import java.io.IOException;
+import java.util.Comparator;
+import java.util.List;
+
+import org.jacoco.core.analysis.ICoverageNode;
+import org.jacoco.report.ReportOutputFolder;
+import org.jacoco.report.html.HTMLElement;
+import org.jacoco.report.internal.html.resources.Resources;
+
+/**
+ * Renderer for a single column of a coverage table. The methods are always
+ * called in the sequence <code>init header footer item*</code>. Implementations
+ * might be stateful.
+ *
+ * @author Marc R. Hoffmann
+ * @version $qualified.bundle.version$
+ */
+public interface IColumnRenderer {
+
+ /**
+ * Initializes the column before any output method is called.
+ *
+ * @param items
+ * all items that will be displayed in the table
+ * @param total
+ * the summary of all coverage data items in the table
+ * @return <code>true</code> if the column should be visible
+ */
+ public boolean init(List<? extends ITableItem> items, ICoverageNode total);
+
+ /**
+ * Renders the footer for this column.
+ *
+ * @param td
+ * the parent table cell
+ * @param total
+ * the summary of all coverage data items in the table
+ * @param resources
+ * static resources that might be referenced
+ * @param base
+ * base folder of the table
+ * @throws IOException
+ * in case of IO problems with the element output
+ */
+ public void footer(HTMLElement td, ICoverageNode total,
+ Resources resources, ReportOutputFolder base) throws IOException;
+
+ /**
+ * Renders a single item in this column.
+ *
+ * @param td
+ * the parent table cell
+ * @param item
+ * the item to display
+ * @param resources
+ * static resources that might be referenced
+ * @param base
+ * base folder of the table
+ * @throws IOException
+ * in case of IO problems with the element output
+ */
+ public void item(HTMLElement td, ITableItem item, Resources resources,
+ ReportOutputFolder base) throws IOException;
+
+ /**
+ * Returns the comparator to sort this table column.
+ *
+ * @return comparator for this column
+ */
+ public Comparator<ITableItem> getComparator();
+
+}
|