Add missing javadocs

DEVSIX-6349

Author: ars18wrw

src/main/java/com/itextpdf/pdfcleanup/PdfCleanUpEventListener.java

@@ -55,13 +55,19 @@ This file is part of the iText (R) project.
 import java.util.List;
 import java.util.Set;
 
+/**
+ * An event listener which handles cleanup related events.
+ */
 public class PdfCleanUpEventListener implements IEventListener {
     private static final String textDataExpected = "Text data expected.";
     private static final String imageDataExpected = "Image data expected.";
     private static final String pathDataExpected = "Path data expected.";
 
     private List<IEventData> content = new ArrayList<>();
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void eventOccurred(IEventData data, EventType type) {
         switch (type) {
@@ -134,6 +140,9 @@ PathRenderInfo getEncounteredPath() {
 
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Set<EventType> getSupportedEvents() {
         return null;

src/main/java/com/itextpdf/pdfcleanup/PdfCleanUpProcessor.java

@@ -106,6 +106,9 @@ This file is part of the iText (R) project.
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * PDF content stream processor, which filters content to be cleaned up.
+ */
 public class PdfCleanUpProcessor extends PdfCanvasProcessor {
 
     private static final Set<String> TEXT_SHOWING_OPERATORS = Collections.unmodifiableSet(new HashSet<String>(

src/main/java/com/itextpdf/pdfcleanup/PdfCleanUpTool.java

@@ -183,6 +183,13 @@ public PdfCleanUpTool(PdfDocument pdfDocument, List<PdfCleanUpLocation> cleanUpL
         }
     }
 
+    /**
+     * Adds a {@link PdfCleanUpLocation} to be cleaned up.
+     *
+     * @param cleanUpLocation a {@link PdfCleanUpLocation} to be cleaned up
+     *
+     * @return this {@link PdfCleanUpTool}
+     */
     public PdfCleanUpTool addCleanupLocation(PdfCleanUpLocation cleanUpLocation) {
         List<PdfCleanUpLocation> pgLocations = this.pdfCleanUpLocations.get(cleanUpLocation.getPage());
         if (pgLocations == null) {
@@ -362,7 +369,7 @@ private List<Rectangle> translateQuadPointsToRectangles(PdfArray quadPoints) {
      * Remove the redaction annotations.
      * This method is called after the annotations are processed.
      *
-     * @throws IOException
+     * @throws IOException signals that an I/O exception has occurred during redaction.
      */
     private void removeRedactAnnots() throws IOException {
         for (PdfRedactAnnotation annotation : redactAnnotations.keySet()) {

src/main/java/com/itextpdf/pdfcleanup/autosweep/CompositeCleanupStrategy.java

@@ -62,21 +62,33 @@ This file is part of the iText (R) project.
 
 
 /**
- * This class is a composite pattern for {@code ICleanupStrategy}
+ * This class is a composite pattern for {@link ICleanupStrategy}.
  * It allows users to have multiple ICleanupStrategy implementations and bundle them as one.
  */
 public class CompositeCleanupStrategy implements ICleanupStrategy {
 
     private Map<Integer, Set<IPdfTextLocation>> locations = new HashMap<>();
     private List<ICleanupStrategy> strategies = new ArrayList<>();
 
+    /**
+     * Creates a {@link CompositeCleanupStrategy composite pattern} for {@link ICleanupStrategy cleanup strategies}.
+     */
     public CompositeCleanupStrategy() {
     }
 
-    public void add(ICleanupStrategy ies) {
-        strategies.add(ies);
+    /**
+     * Adds a {@link ICleanupStrategy cleanup strategy} to this {@link CompositeCleanupStrategy composite pattern}.
+     *
+     * @param strategy a {@link ICleanupStrategy cleanup strategy} to be added to this
+     *     {@link CompositeCleanupStrategy composite pattern}.
+     */
+    public void add(ICleanupStrategy strategy) {
+        strategies.add(strategy);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Collection<IPdfTextLocation> getResultantLocations() {
         locations.clear();
@@ -104,10 +116,12 @@ public int compare(IPdfTextLocation l1, IPdfTextLocation l2) {
             }
         });
 
-        // return
         return rectangles;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Color getRedactionColor(IPdfTextLocation location) {
         for (int i = 0; i < strategies.size(); i++) {
@@ -118,13 +132,19 @@ public Color getRedactionColor(IPdfTextLocation location) {
         return ColorConstants.BLACK;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public void eventOccurred(IEventData data, EventType type) {
         for (ILocationExtractionStrategy s : strategies) {
             s.eventOccurred(data, type);
         }
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Set<EventType> getSupportedEvents() {
         Set<EventType> evts = new HashSet<>();
@@ -136,13 +156,20 @@ public Set<EventType> getSupportedEvents() {
         return evts.isEmpty() ? null : evts;
     }
 
-    public ICleanupStrategy reset()
-    {
-        CompositeCleanupStrategy retval = new CompositeCleanupStrategy();
-        for(ICleanupStrategy s : strategies)
-        {
-            retval.add(s.reset());
+    /**
+     * Returns a {@link ICleanupStrategy cleanup strategy} which represents
+     * a reset {@link CompositeCleanupStrategy composite cleanup strategy}.
+     *
+     * <p>
+     * Note that all the inner {@link ICleanupStrategy strategies} will be reset as well.
+     *
+     * @return a reset {@link CompositeCleanupStrategy composite strategy}
+     */
+    public ICleanupStrategy reset() {
+        CompositeCleanupStrategy resetCompositeStrategy = new CompositeCleanupStrategy();
+        for(ICleanupStrategy s : strategies) {
+            resetCompositeStrategy.add(s.reset());
         }
-        return retval;
+        return resetCompositeStrategy;
     }
 }

src/main/java/com/itextpdf/pdfcleanup/autosweep/RegexBasedCleanupStrategy.java

@@ -57,26 +57,51 @@ public class RegexBasedCleanupStrategy extends RegexBasedLocationExtractionStrat
     private Pattern pattern;
     private Color redactionColor = ColorConstants.BLACK;
 
+    /**
+     * Creates an object of regular expression based cleanup strategy.
+     *
+     * @param regex regular expression on which cleanup strategy will be based
+     */
     public RegexBasedCleanupStrategy(String regex) {
         super(regex);
         this.pattern = Pattern.compile(regex);
     }
 
+    /**
+     * Creates an object of regular expression based cleanup strategy.
+     *
+     * @param pattern {@link Pattern} pattern on which cleanup strategy will be based
+     */
     public RegexBasedCleanupStrategy(Pattern pattern) {
         super(pattern);
         this.pattern = pattern;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     @Override
     public Color getRedactionColor(IPdfTextLocation location) {
         return redactionColor;
     }
 
+    /**
+     * Sets the color in which redaction is to take place.
+     *
+     * @param color the color in which redaction is to take place
+     * 
+     * @return this {@link RegexBasedCleanupStrategy strategy}
+     */
     public RegexBasedCleanupStrategy setRedactionColor(Color color) {
         this.redactionColor = color;
         return this;
     }
 
+    /**
+     * Returns an {@link ICleanupStrategy} object which is set to this regular pattern and redaction color.
+     *
+     * @return a reset {@link ICleanupStrategy cleanup strategy}
+     */
     public ICleanupStrategy reset() {
         return new RegexBasedCleanupStrategy(pattern).setRedactionColor(redactionColor);
     }

src/main/java/com/itextpdf/pdfcleanup/logs/CleanUpLogMessageConstant.java

@@ -22,6 +22,9 @@ This file is part of the iText (R) project.
  */
 package com.itextpdf.pdfcleanup.logs;
 
+/**
+ * Class that bundles all the log message templates as constants.
+ */
 public class CleanUpLogMessageConstant {
 
     /** The Constant CANNOT_OBTAIN_IMAGE_INFO_AFTER_FILTERING. */