svn commit: r1753588 - /pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigBuilder.java

[ti...@apache.org]

Author: tilman
Date: Wed Jul 20 18:07:23 2016
New Revision: 1753588

URL: http://svn.apache.org/viewvc?rev=1753588&view=rev
Log:
PDFBOX-3017: rename parameter names; improve javadoc

Modified:
    pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigBuilder.java

Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigBuilder.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigBuilder.java?rev=1753588&r1=1753587&r2=1753588&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigBuilder.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDVisibleSigBuilder.java Wed Jul 20 18:07:23 2016
@@ -44,7 +44,8 @@ import org.apache.pdfbox.pdmodel.interac
 import org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField;
 
 /**
- * Implementation of {@link PDFTemplateBuilder}.
+ * Implementation of {@link PDFTemplateBuilder}. This builds the signature PDF but doesn't keep the
+ * elements, these are kept in its PDF template structure.
  *
  * @author Vakhtang Koroghlishvili
  */
@@ -54,7 +55,7 @@ public class PDVisibleSigBuilder impleme
     private static final Log log = LogFactory.getLog(PDVisibleSigBuilder.class);
 
     /**
-     * Constructor.
+     * Constructor, creates PDF template structure.
      */
     public PDVisibleSigBuilder()
     {
@@ -71,6 +72,13 @@ public class PDVisibleSigBuilder impleme
         log.info("PDF page has been created");
     }
 
+    /**
+     * Creates a PDDocument and adds the page parameter to it and keeps this as a template in the
+     * PDF template Structure.
+     *
+     * @param page
+     * @throws IOException
+     */
     @Override
     public void createTemplate(PDPage page) throws IOException
     {
@@ -103,15 +111,15 @@ public class PDVisibleSigBuilder impleme
     }
 
     @Override
-    public void createSignature(PDSignatureField pdSignatureField, PDPage page,
-                                String signatureName) throws IOException
+    public void createSignature(PDSignatureField pdSignatureField, PDPage page, String signerName)
+            throws IOException
     {
         PDSignature pdSignature = new PDSignature();
         PDAnnotationWidget widget = pdSignatureField.getWidgets().get(0);
         pdSignatureField.setValue(pdSignature);
         widget.setPage(page);
         page.getAnnotations().add(widget);
-        pdSignature.setName(signatureName);
+        pdSignature.setName(signerName);
         pdfStructure.setPdSignature(pdSignature);
         log.info("PDSignature has been created");
     }