You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2016/07/20 17:15:23 UTC
svn commit: r1753573 -
/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java
Author: tilman
Date: Wed Jul 20 17:15:23 2016
New Revision: 1753573
URL: http://svn.apache.org/viewvc?rev=1753573&view=rev
Log:
PDFBOX-3017: improve javadoc, rename parameter names
Modified:
pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java
Modified: pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java?rev=1753573&r1=1753572&r2=1753573&view=diff
==============================================================================
--- pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java (original)
+++ pdfbox/branches/2.0/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/interactive/digitalsignature/visible/PDFTemplateCreator.java Wed Jul 20 17:15:23 2016
@@ -34,28 +34,29 @@ import org.apache.pdfbox.pdmodel.interac
import org.apache.pdfbox.pdmodel.interactive.form.PDSignatureField;
/**
- * Using that class, we build pdf template.
+ * Class to build PDF template.
+ *
* @author Vakhtang Koroghlishvili
*/
public class PDFTemplateCreator
{
- PDFTemplateBuilder pdfBuilder;
+ private final PDFTemplateBuilder pdfBuilder;
private static final Log logger = LogFactory.getLog(PDFTemplateCreator.class);
/**
- * sets PDFBuilder
+ * Constructor.
*
- * @param bookBuilder
+ * @param templateBuilder
*/
- public PDFTemplateCreator(PDFTemplateBuilder bookBuilder)
+ public PDFTemplateCreator(PDFTemplateBuilder templateBuilder)
{
- pdfBuilder = bookBuilder;
+ pdfBuilder = templateBuilder;
}
/**
- * that method returns object of PDFStructure
+ * Returns the PDFTemplateStructure object.
*
- * @return PDFStructure
+ * @return
*/
public PDFTemplateStructure getPdfStructure()
{
@@ -63,7 +64,8 @@ public class PDFTemplateCreator
}
/**
- * this method builds pdf step by step, and finally it returns stream of visible signature
+ * Build a PDF with a visible signature step by step, and return it as a stream.
+ *
* @param properties
* @return InputStream
* @throws IOException