From 57c431ae87b37251f7512499e09c3c63f8c9186c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kasper=20S=C3=B8rensen?= Date: Thu, 16 Apr 2015 11:16:33 +0200 Subject: [PATCH] Made sure javadoc on Java 8 passes without linter errors on API modules --- api/pom.xml | 16 +++++++++- .../java/org/datacleaner/api/Initialize.java | 3 +- .../java/org/datacleaner/api/InputRow.java | 4 --- .../org/datacleaner/api/OutputColumns.java | 5 --- .../descriptors/ComponentDescriptor.java | 2 +- .../descriptors/DescriptorProvider.java | 2 +- .../descriptors/FilterDescriptor.java | 4 ++- .../descriptors/RendererBeanDescriptor.java | 31 +++++++++++++++---- .../java/org/datacleaner/job/AnalysisJob.java | 6 ++-- .../datacleaner/job/ComponentRequirement.java | 11 ++++++- .../metadata/HasColumnMetadata.java | 2 +- .../datacleaner/reference/StringPattern.java | 2 +- .../storage/RowAnnotationFactory.java | 10 +++--- desktop/api/pom.xml | 15 ++++++++- .../org/datacleaner/util/WidgetUtils.java | 2 +- .../widgets/DefaultToggleButtonUI.java | 5 ++- .../datacleaner/widgets/table/DCTable.java | 2 +- 17 files changed, 86 insertions(+), 36 deletions(-) diff --git a/api/pom.xml b/api/pom.xml index 0eea2ba648..397e63269a 100644 --- a/api/pom.xml +++ b/api/pom.xml @@ -1,4 +1,5 @@ - + 4.0.0 org.eobjects.datacleaner @@ -6,6 +7,19 @@ 4.1-SNAPSHOT DataCleaner-api + + + + + org.apache.maven.plugins + maven-javadoc-plugin + + false + + + + + org.apache.metamodel diff --git a/api/src/main/java/org/datacleaner/api/Initialize.java b/api/src/main/java/org/datacleaner/api/Initialize.java index 190b89f056..6afd7fff17 100644 --- a/api/src/main/java/org/datacleaner/api/Initialize.java +++ b/api/src/main/java/org/datacleaner/api/Initialize.java @@ -54,7 +54,8 @@ * consulted to determine if the initialization methods should be executed on * all nodes or just on a single (typically master) node, before distribution. * - * @Initialize is often used in conjunction with the @Close annotation. + * {@link Initialize} is often used in conjunction with the {@link Close} + * annotation. * * @see Close */ diff --git a/api/src/main/java/org/datacleaner/api/InputRow.java b/api/src/main/java/org/datacleaner/api/InputRow.java index 2069f72ae2..0475940e97 100644 --- a/api/src/main/java/org/datacleaner/api/InputRow.java +++ b/api/src/main/java/org/datacleaner/api/InputRow.java @@ -28,10 +28,6 @@ * An InputRow can contain both values that are physical (ie. a raw output from * a datastore) and virtual (ie. generated values, created by Transformers). * - * The contents of an InputRow is visualized in the image below: - * - * InputRow contents - * * @see Transformer * @see InputColumn */ diff --git a/api/src/main/java/org/datacleaner/api/OutputColumns.java b/api/src/main/java/org/datacleaner/api/OutputColumns.java index 9e0ab9fa50..0c7462c6ec 100644 --- a/api/src/main/java/org/datacleaner/api/OutputColumns.java +++ b/api/src/main/java/org/datacleaner/api/OutputColumns.java @@ -25,11 +25,6 @@ /** * Represents the output columns yielded by a Transformer given a certain * configuration. - * - * By default the output columns of a transformer will have the type specified - * by the generic argument (E) in {@link Transformer}. The column type can - * however be overridden using the output columns, by setting specific column - * types per column index using the {@link #setColumnType(int, Class)} method. */ public class OutputColumns implements Serializable { diff --git a/api/src/main/java/org/datacleaner/descriptors/ComponentDescriptor.java b/api/src/main/java/org/datacleaner/descriptors/ComponentDescriptor.java index 534b74b2f9..7c5878123c 100644 --- a/api/src/main/java/org/datacleaner/descriptors/ComponentDescriptor.java +++ b/api/src/main/java/org/datacleaner/descriptors/ComponentDescriptor.java @@ -90,7 +90,7 @@ public interface ComponentDescriptor extends ComparableDescriptors class' helper methods. It is however advised to use the * {@link DescriptorProvider} since it keeps a proper registry of descriptors * used, and reuses existing descriptor definitions. */ diff --git a/api/src/main/java/org/datacleaner/descriptors/FilterDescriptor.java b/api/src/main/java/org/datacleaner/descriptors/FilterDescriptor.java index e862157426..ea379bf6bf 100644 --- a/api/src/main/java/org/datacleaner/descriptors/FilterDescriptor.java +++ b/api/src/main/java/org/datacleaner/descriptors/FilterDescriptor.java @@ -29,8 +29,10 @@ /** * {@link ComponentDescriptor} interface for {@link Filter}s. * - * @param + * @param * the type of {@link Filter} + * @param + * the {@link Filter}s category type */ public interface FilterDescriptor, C extends Enum> extends ComponentDescriptor { diff --git a/api/src/main/java/org/datacleaner/descriptors/RendererBeanDescriptor.java b/api/src/main/java/org/datacleaner/descriptors/RendererBeanDescriptor.java index 68db562dfb..36c469cb4d 100644 --- a/api/src/main/java/org/datacleaner/descriptors/RendererBeanDescriptor.java +++ b/api/src/main/java/org/datacleaner/descriptors/RendererBeanDescriptor.java @@ -25,20 +25,39 @@ import org.datacleaner.api.RenderingFormat; /** - * Defines an abstract descriptor for renderer beans. + * Defines an abstract {@link ComponentDescriptor} for {@link Renderer}s. * * @see RendererBean - * - * - * - * @param - * the Bean type + * + * @param + * the type of {@link Renderer} */ public interface RendererBeanDescriptor> extends ComponentDescriptor { + /** + * Gets the {@link RenderingFormat} that this renderer pertains to. The type + * returned by {@link RenderingFormat#getOutputClass()} will typically + * correspond to accepted types of {@link #isOutputApplicableFor(Class)}. + * + * @return + */ public Class> getRenderingFormat(); + /** + * Gets the type of {@link Renderable} that this renderer can render. + * + * @return + */ public Class getRenderableType(); + /** + * Determines if an object of the provided class argument can be provided + * using this renderer. + * + * @see #getRenderingFormat() + * + * @param requiredClass + * @return + */ boolean isOutputApplicableFor(Class requiredClass); } diff --git a/api/src/main/java/org/datacleaner/job/AnalysisJob.java b/api/src/main/java/org/datacleaner/job/AnalysisJob.java index f5f9930aa7..7547bf5d21 100644 --- a/api/src/main/java/org/datacleaner/job/AnalysisJob.java +++ b/api/src/main/java/org/datacleaner/job/AnalysisJob.java @@ -33,11 +33,9 @@ * A {@link AnalysisJob} references a source {@link Datastore} and some * {@link Column}s (represented via {@link InputColumn}s) of this datastore. * - * Building jobs is usually done using the - * {@link org.datacleaner.job.builder.AnalysisJobBuilder} class. + * Building jobs is usually done using the AnalysisJobBuilder class. * - * Executing jobs is usually done using the - * {@link org.datacleaner.job.runner.AnalysisRunner} interface. + * Executing jobs is usually done using the AnalysisRunner interface. */ public interface AnalysisJob { diff --git a/api/src/main/java/org/datacleaner/job/ComponentRequirement.java b/api/src/main/java/org/datacleaner/job/ComponentRequirement.java index a8ad8556f0..1c1b6425a2 100644 --- a/api/src/main/java/org/datacleaner/job/ComponentRequirement.java +++ b/api/src/main/java/org/datacleaner/job/ComponentRequirement.java @@ -48,7 +48,7 @@ public interface ComponentRequirement extends Serializable { * Gets the {@link FilterOutcome}s that this requirement depends on at * processing time. During processing, each {@link FilterOutcome} returned * from this method will have been evaluated before calling - * {@link #isSatisfied(FilterOutcomes)}. + * {@link #isSatisfied(InputRow, FilterOutcomes)}. * * @return */ @@ -62,4 +62,13 @@ public interface ComponentRequirement extends Serializable { * @return */ public String getSimpleName(); + + /** + * Provides textual representation of context and technical information + * about the {@link ComponentRequirement} + * + * @return + */ + @Override + public String toString(); } diff --git a/api/src/main/java/org/datacleaner/metadata/HasColumnMetadata.java b/api/src/main/java/org/datacleaner/metadata/HasColumnMetadata.java index 2257b881aa..ebdb3999eb 100644 --- a/api/src/main/java/org/datacleaner/metadata/HasColumnMetadata.java +++ b/api/src/main/java/org/datacleaner/metadata/HasColumnMetadata.java @@ -43,7 +43,7 @@ public interface HasColumnMetadata { /** * Gets {@link ColumnMetadata} for a particular {@link Column}. * - * @param columnName + * @param column * @return a {@link ColumnMetadata} object, or null if no metadata about the * column is available. */ diff --git a/api/src/main/java/org/datacleaner/reference/StringPattern.java b/api/src/main/java/org/datacleaner/reference/StringPattern.java index 897315329d..c5a186c11c 100644 --- a/api/src/main/java/org/datacleaner/reference/StringPattern.java +++ b/api/src/main/java/org/datacleaner/reference/StringPattern.java @@ -30,7 +30,7 @@ *
  • The pattern "Aaaaaa Aaaaaaaaaa" which is a typical firstname and lastname * pattern.
    • *
  • The pattern ".*@.*" which is a simple way to identify strings with an - * @-sign in them (potential email).
    • + * '@'-sign in them (potential email). * * * A string pattern can have methods annotated with @Initialize and @Close. diff --git a/api/src/main/java/org/datacleaner/storage/RowAnnotationFactory.java b/api/src/main/java/org/datacleaner/storage/RowAnnotationFactory.java index c0ca7d3739..ddf2407862 100644 --- a/api/src/main/java/org/datacleaner/storage/RowAnnotationFactory.java +++ b/api/src/main/java/org/datacleaner/storage/RowAnnotationFactory.java @@ -21,8 +21,10 @@ import java.util.Map; +import org.datacleaner.api.Component; import org.datacleaner.api.InputColumn; import org.datacleaner.api.InputRow; +import org.datacleaner.api.Provided; /** * The RowAnnotationFactory represents a mechanism used to annotate/label rows @@ -31,10 +33,8 @@ * component needs to manage a set of labels but where storing them in * collections would be too complicated and would fill up memory. * - * The RowAnnotationFactory is injectable into any row processing component - * (analyzer, transformer, filter) using the @Provided annotation. - * - * @see Provided + * The RowAnnotationFactory is injectable into any {@link Component} (analyzer, + * transformer, filter) using the {@link Provided} annotation. */ public interface RowAnnotationFactory { @@ -44,7 +44,7 @@ public interface RowAnnotationFactory { * @return a new annotation */ public RowAnnotation createAnnotation(); - + /** * Annotates an array of rows (all assumed to have distinct count = 1). * diff --git a/desktop/api/pom.xml b/desktop/api/pom.xml index 25622eb294..322b660109 100644 --- a/desktop/api/pom.xml +++ b/desktop/api/pom.xml @@ -1,4 +1,5 @@ - + 4.0.0 org.eobjects.datacleaner @@ -8,6 +9,18 @@ DataCleaner-desktop-api jar + + + + org.apache.maven.plugins + maven-javadoc-plugin + + false + + + + + diff --git a/desktop/api/src/main/java/org/datacleaner/util/WidgetUtils.java b/desktop/api/src/main/java/org/datacleaner/util/WidgetUtils.java index 6abfb5b2dd..f60f71ebbe 100644 --- a/desktop/api/src/main/java/org/datacleaner/util/WidgetUtils.java +++ b/desktop/api/src/main/java/org/datacleaner/util/WidgetUtils.java @@ -363,7 +363,7 @@ public static void addToGridBag(Component comp, JPanel panel, int x, int y, int * * @param comp * @param panel - * @param gridxs + * @param gridx * @param gridy */ public static void addToGridBag(Component comp, JPanel panel, int gridx, int gridy) { diff --git a/desktop/api/src/main/java/org/datacleaner/widgets/DefaultToggleButtonUI.java b/desktop/api/src/main/java/org/datacleaner/widgets/DefaultToggleButtonUI.java index 7916c5c1d6..4f74f104d2 100644 --- a/desktop/api/src/main/java/org/datacleaner/widgets/DefaultToggleButtonUI.java +++ b/desktop/api/src/main/java/org/datacleaner/widgets/DefaultToggleButtonUI.java @@ -23,12 +23,15 @@ import java.awt.Cursor; import javax.swing.AbstractButton; +import javax.swing.JToggleButton; +import javax.swing.plaf.ButtonUI; import javax.swing.plaf.metal.MetalToggleButtonUI; import org.datacleaner.util.WidgetUtils; /*** - * A {@link ToggleButtonUI} for default buttons in the DataCleaner user interface. + * A {@link ButtonUI} for default {@link JToggleButton}s in the DataCleaner user + * interface. */ public class DefaultToggleButtonUI extends MetalToggleButtonUI { diff --git a/desktop/api/src/main/java/org/datacleaner/widgets/table/DCTable.java b/desktop/api/src/main/java/org/datacleaner/widgets/table/DCTable.java index ba1de20fae..4c2d5b847c 100644 --- a/desktop/api/src/main/java/org/datacleaner/widgets/table/DCTable.java +++ b/desktop/api/src/main/java/org/datacleaner/widgets/table/DCTable.java @@ -261,7 +261,7 @@ private boolean forwardMouseEvent(MouseEvent e) { * Copies content from the table to the clipboard. Algorithm is a slight * rewrite of the article below. * - * @see http://www.copy--paste.org/copy-paste-jtables-excel.htm + * @see http://www.copy--paste.org/copy-paste-jtables-excel.htm */ public void copyToClipboard(int rowIndex, int colIndex, int width, int height) { StringBuilder sb = new StringBuilder();