Builder-like pattern for PdfSignatureAppearance

DEVSIX-391

Author: pavel-alay

sign/src/main/java/com/itextpdf/signatures/PdfSignatureAppearance.java

@@ -190,8 +190,9 @@ public int getPageNumber() {
      * @param pageNumber The page number of the signature field which
      *                   this signature appearance is associated with.
      */
-    public void setPageNumber(int pageNumber) {
+    public PdfSignatureAppearance setPageNumber(int pageNumber) {
         this.page = pageNumber;
+        return this;
     }
 
     /**
@@ -212,9 +213,10 @@ public Rectangle getPageRect() {
      * @param pageRect The rectangle that represents the position and
      *                 dimension of the signature field in the page.
      */
-    public void setPageRect(Rectangle pageRect) {
+    public PdfSignatureAppearance setPageRect(Rectangle pageRect) {
         this.pageRect = new Rectangle(pageRect);
         this.rect = new Rectangle(pageRect.getWidth(), pageRect.getHeight());
+        return this;
     }
 
     /**
@@ -259,8 +261,9 @@ public RenderingMode getRenderingMode() {
      *
      * @param renderingMode the rendering mode
      */
-    public void setRenderingMode(RenderingMode renderingMode) {
+    public PdfSignatureAppearance setRenderingMode(RenderingMode renderingMode) {
         this.renderingMode = renderingMode;
+        return this;
     }
 
     /**
@@ -277,17 +280,19 @@ public String getReason() {
      *
      * @param reason signing reason.
      */
-    public void setReason(String reason) {
+    public PdfSignatureAppearance setReason(String reason) {
         this.reason = reason;
+        return this;
     }
 
     /**
      * Sets the caption for the signing reason.
      *
      * @param reasonCaption A new signing reason caption
      */
-    public void setReasonCaption(String reasonCaption) {
+    public PdfSignatureAppearance setReasonCaption(String reasonCaption) {
         this.reasonCaption = reasonCaption;
+        return this;
     }
 
     /**
@@ -304,17 +309,19 @@ public String getLocation() {
      *
      * @param location A new signing location
      */
-    public void setLocation(String location) {
+    public PdfSignatureAppearance setLocation(String location) {
         this.location = location;
+        return this;
     }
 
     /**
      * Sets the caption for the signing location.
      *
      * @param locationCaption A new signing location caption
      */
-    public void setLocationCaption(String locationCaption) {
+    public PdfSignatureAppearance setLocationCaption(String locationCaption) {
         this.locationCaption = locationCaption;
+        return this;
     }
 
     /**
@@ -331,8 +338,9 @@ public String getSignatureCreator(){
      *
      * @param signatureCreator A new name of the application signing a document
      */
-    public void setSignatureCreator(String signatureCreator){
+    public PdfSignatureAppearance setSignatureCreator(String signatureCreator){
         this.signatureCreator = signatureCreator;
+        return this;
     }
 
     /**
@@ -349,8 +357,9 @@ public String getContact() {
      *
      * @param contact A new signing contact
      */
-    public void setContact(String contact) {
+    public PdfSignatureAppearance setContact(String contact) {
         this.contact = contact;
+        return this;
     }
 
     /**
@@ -359,8 +368,9 @@ public void setContact(String contact) {
      *
      * @param signCertificate the certificate
      */
-    public void setCertificate(Certificate signCertificate) {
+    public PdfSignatureAppearance setCertificate(Certificate signCertificate) {
         this.signCertificate = signCertificate;
+        return this;
     }
 
     /**
@@ -386,15 +396,17 @@ public Image getSignatureGraphic() {
      *
      * @param signatureGraphic image rendered. If null the mode is defaulted to RenderingMode.DESCRIPTION
      */
-    public void setSignatureGraphic(Image signatureGraphic) {
+    public PdfSignatureAppearance setSignatureGraphic(Image signatureGraphic) {
         this.signatureGraphic = signatureGraphic;
+        return this;
     }
 
     /**
      * Indicates that the existing appearances needs to be reused as layer 0.
      */
-    public void setReuseAppearance(boolean reuseAppearance) {
+    public PdfSignatureAppearance setReuseAppearance(boolean reuseAppearance) {
         this.reuseAppearance = reuseAppearance;
+        return this;
     }
 
     // layer 2
@@ -413,8 +425,9 @@ public Image getImage() {
      *
      * @param image the background image for the layer 2
      */
-    public void setImage(Image image) {
+    public PdfSignatureAppearance setImage(Image image) {
         this.image = image;
+        return this;
     }
 
     /**
@@ -434,8 +447,9 @@ public float getImageScale() {
      *
      * @param imageScale the scaling to be applied to the background image
      */
-    public void setImageScale(float imageScale) {
+    public PdfSignatureAppearance setImageScale(float imageScale) {
         this.imageScale = imageScale;
+        return this;
     }
 
     /**
@@ -444,8 +458,9 @@ public void setImageScale(float imageScale) {
      * @param text the signature text identifying the signer. If null or not set
      * a standard description will be used
      */
-    public void setLayer2Text(String text) {
+    public PdfSignatureAppearance setLayer2Text(String text) {
         layer2Text = text;
+        return this;
     }
 
     /**
@@ -471,17 +486,19 @@ public PdfFont getLayer2Font() {
      *
      * @param layer2Font the n2 and n4 font
      */
-    public void setLayer2Font(PdfFont layer2Font) {
+    public PdfSignatureAppearance setLayer2Font(PdfFont layer2Font) {
         this.layer2Font = layer2Font;
+        return this;
     }
 
     /**
      * Sets the n2 and n4 layer font size.
      *
      * @param fontSize font size
      */
-    public void setLayer2FontSize(float fontSize) {
+    public PdfSignatureAppearance setLayer2FontSize(float fontSize) {
         this.layer2FontSize = fontSize;
+        return this;
     }
 
     /**
@@ -779,17 +796,19 @@ protected java.util.Calendar getSignDate() {
      *
      * @param signDate A new signature date
      */
-    protected void setSignDate(java.util.Calendar signDate) {
+    protected PdfSignatureAppearance setSignDate(java.util.Calendar signDate) {
         this.signDate = signDate;
+        return this;
     }
 
     /**
      * Set the field name of the appearance.
      *
      * @param fieldName name of the field
      */
-    protected void setFieldName(String fieldName) {
+    protected PdfSignatureAppearance setFieldName(String fieldName) {
         this.fieldName = fieldName;
+        return this;
     }
 
     private void createBlankN0() {

sign/src/test/java/com/itextpdf/signatures/SigningTest.java

@@ -135,11 +135,10 @@ protected void sign(String src, String name, String dest,
         PdfSigner signer = new PdfSigner(reader, new PdfWriter(dest), false);
 
         // Creating the appearance
-        PdfSignatureAppearance appearance = signer.getSignatureAppearance();
-        appearance.setReason(reason);
-        appearance.setLocation(location);
-
-        appearance.setReuseAppearance(setReuseAppearance);
+        PdfSignatureAppearance appearance = signer.getSignatureAppearance()
+            .setReason(reason)
+            .setLocation(location)
+            .setReuseAppearance(setReuseAppearance);
 
         if (rectangleForNewField != null) {
             appearance.setPageRect(rectangleForNewField);