PDFBOX-6049: improve naming

THausherr · THausherr · commit 5f5fd46e346c · 2025-08-08T12:04:49.000Z
git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1927696 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java b/pdfbox/src/main/java/org/apache/pdfbox/multipdf/Overlay.java
@@ -81,22 +81,22 @@ public enum Position
     private PDDocument inputPDFDocument = null;
 
     private String defaultOverlayFilename = null;
-    private PDDocument defaultOverlay = null;
+    private PDDocument defaultOverlayDocument = null;
 
     private String firstPageOverlayFilename = null;
-    private PDDocument firstPageOverlay = null;
+    private PDDocument firstPageOverlayDocument = null;
 
     private String lastPageOverlayFilename = null;
-    private PDDocument lastPageOverlay = null;
+    private PDDocument lastPageOverlayDocument = null;
     
     private String allPagesOverlayFilename = null;
-    private PDDocument allPagesOverlay = null;
+    private PDDocument allPagesOverlayDocument = null;
     
     private String oddPageOverlayFilename = null;
-    private PDDocument oddPageOverlay = null;
+    private PDDocument oddPageOverlayDocument = null;
     
     private String evenPageOverlayFilename = null;
-    private PDDocument evenPageOverlay = null;
+    private PDDocument evenPageOverlayDocument = null;
 
     private int numberOfOverlayPages = 0;
     private boolean useAllOverlayPages = false;
@@ -174,29 +174,29 @@ public PDDocument overlayDocuments(Map<Integer, PDDocument> specificPageOverlayD
     @Override
     public void close() throws IOException
     {
-        if (defaultOverlay != null)
+        if (defaultOverlayDocument != null)
         {
-            defaultOverlay.close();
+            defaultOverlayDocument.close();
         }
-        if (firstPageOverlay != null)
+        if (firstPageOverlayDocument != null)
         {
-            firstPageOverlay.close();
+            firstPageOverlayDocument.close();
         }
-        if (lastPageOverlay != null)
+        if (lastPageOverlayDocument != null)
         {
-            lastPageOverlay.close();
+            lastPageOverlayDocument.close();
         }
-        if (allPagesOverlay != null)
+        if (allPagesOverlayDocument != null)
         {
-            allPagesOverlay.close();
+            allPagesOverlayDocument.close();
         }
-        if (oddPageOverlay != null)
+        if (oddPageOverlayDocument != null)
         {
-            oddPageOverlay.close();
+            oddPageOverlayDocument.close();
         }
-        if (evenPageOverlay != null)
+        if (evenPageOverlayDocument != null)
         {
-            evenPageOverlay.close();
+            evenPageOverlayDocument.close();
         }
         for (PDDocument doc : openDocumentsSet)
         {
@@ -220,56 +220,56 @@ private void loadPDFs() throws IOException
         // default overlay PDF
         if (defaultOverlayFilename != null)
         {
-            defaultOverlay = loadPDF(defaultOverlayFilename);
+            defaultOverlayDocument = loadPDF(defaultOverlayFilename);
         }
-        if (defaultOverlay != null)
+        if (defaultOverlayDocument != null)
         {
-            defaultOverlayPage = createLayoutPageFromDocument(defaultOverlay);
+            defaultOverlayPage = createLayoutPageFromDocument(defaultOverlayDocument);
         }
         // first page overlay PDF
         if (firstPageOverlayFilename != null)
         {
-            firstPageOverlay = loadPDF(firstPageOverlayFilename);
+            firstPageOverlayDocument = loadPDF(firstPageOverlayFilename);
         }
-        if (firstPageOverlay != null)
+        if (firstPageOverlayDocument != null)
         {
-            firstPageOverlayPage = createLayoutPageFromDocument(firstPageOverlay);
+            firstPageOverlayPage = createLayoutPageFromDocument(firstPageOverlayDocument);
         }
         // last page overlay PDF
         if (lastPageOverlayFilename != null)
         {
-            lastPageOverlay = loadPDF(lastPageOverlayFilename);
+            lastPageOverlayDocument = loadPDF(lastPageOverlayFilename);
         }
-        if (lastPageOverlay != null)
+        if (lastPageOverlayDocument != null)
         {
-            lastPageOverlayPage = createLayoutPageFromDocument(lastPageOverlay);
+            lastPageOverlayPage = createLayoutPageFromDocument(lastPageOverlayDocument);
         }
         // odd pages overlay PDF
         if (oddPageOverlayFilename != null)
         {
-            oddPageOverlay = loadPDF(oddPageOverlayFilename);
+            oddPageOverlayDocument = loadPDF(oddPageOverlayFilename);
         }
-        if (oddPageOverlay != null)
+        if (oddPageOverlayDocument != null)
         {
-            oddPageOverlayPage = createLayoutPageFromDocument(oddPageOverlay);
+            oddPageOverlayPage = createLayoutPageFromDocument(oddPageOverlayDocument);
         }
         // even pages overlay PDF
         if (evenPageOverlayFilename != null)
         {
-            evenPageOverlay = loadPDF(evenPageOverlayFilename);
+            evenPageOverlayDocument = loadPDF(evenPageOverlayFilename);
         }
-        if (evenPageOverlay != null)
+        if (evenPageOverlayDocument != null)
         {
-            evenPageOverlayPage = createLayoutPageFromDocument(evenPageOverlay);
+            evenPageOverlayPage = createLayoutPageFromDocument(evenPageOverlayDocument);
         }
         // all pages overlay PDF
         if (allPagesOverlayFilename != null)
         {
-            allPagesOverlay = loadPDF(allPagesOverlayFilename);
+            allPagesOverlayDocument = loadPDF(allPagesOverlayFilename);
         }
-        if (allPagesOverlay != null)
+        if (allPagesOverlayDocument != null)
         {
-            specificPageOverlayLayoutPageMap = createPageOverlayLayoutPageMap(allPagesOverlay);
+            specificPageOverlayLayoutPageMap = createPageOverlayLayoutPageMap(allPagesOverlayDocument);
             useAllOverlayPages = true;
             numberOfOverlayPages = specificPageOverlayLayoutPageMap.size();
         }
@@ -677,7 +677,7 @@ public void setDefaultOverlayFile(String defaultOverlayFile)
      */
     public void setDefaultOverlayPDF(PDDocument defaultOverlayPDF)
     {
-        defaultOverlay = defaultOverlayPDF;
+        defaultOverlayDocument = defaultOverlayPDF;
     }
 
     /**
@@ -708,7 +708,7 @@ public void setFirstPageOverlayFile(String firstPageOverlayFile)
      */
     public void setFirstPageOverlayPDF(PDDocument firstPageOverlayPDF)
     {
-        firstPageOverlay = firstPageOverlayPDF;
+        firstPageOverlayDocument = firstPageOverlayPDF;
     }
 
     /**
@@ -729,7 +729,7 @@ public void setLastPageOverlayFile(String lastPageOverlayFile)
      */
     public void setLastPageOverlayPDF(PDDocument lastPageOverlayPDF)
     {
-        lastPageOverlay = lastPageOverlayPDF;
+        lastPageOverlayDocument = lastPageOverlayPDF;
     }
 
     /**
@@ -751,7 +751,7 @@ public void setAllPagesOverlayFile(String allPagesOverlayFile)
      */
     public void setAllPagesOverlayPDF(PDDocument allPagesOverlayPDF)
     {
-        allPagesOverlay = allPagesOverlayPDF;
+        allPagesOverlayDocument = allPagesOverlayPDF;
     }
 
     /**
@@ -772,7 +772,7 @@ public void setOddPageOverlayFile(String oddPageOverlayFile)
      */
     public void setOddPageOverlayPDF(PDDocument oddPageOverlayPDF)
     {
-        oddPageOverlay = oddPageOverlayPDF;
+        oddPageOverlayDocument = oddPageOverlayPDF;
     }
 
     /**
@@ -793,6 +793,6 @@ public void setEvenPageOverlayFile(String evenPageOverlayFile)
      */
     public void setEvenPageOverlayPDF(PDDocument evenPageOverlayPDF)
     {
-        evenPageOverlay = evenPageOverlayPDF;
+        evenPageOverlayDocument = evenPageOverlayPDF;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -81,22 +81,22 @@ public enum Position`
`81`	`81`	`private PDDocument inputPDFDocument = null;`
`82`	`82`
`83`	`83`	`private String defaultOverlayFilename = null;`
`84`		`- private PDDocument defaultOverlay = null;`
	`84`	`+ private PDDocument defaultOverlayDocument = null;`
`85`	`85`
`86`	`86`	`private String firstPageOverlayFilename = null;`
`87`		`- private PDDocument firstPageOverlay = null;`
	`87`	`+ private PDDocument firstPageOverlayDocument = null;`
`88`	`88`
`89`	`89`	`private String lastPageOverlayFilename = null;`
`90`		`- private PDDocument lastPageOverlay = null;`
	`90`	`+ private PDDocument lastPageOverlayDocument = null;`
`91`	`91`
`92`	`92`	`private String allPagesOverlayFilename = null;`
`93`		`- private PDDocument allPagesOverlay = null;`
	`93`	`+ private PDDocument allPagesOverlayDocument = null;`
`94`	`94`
`95`	`95`	`private String oddPageOverlayFilename = null;`
`96`		`- private PDDocument oddPageOverlay = null;`
	`96`	`+ private PDDocument oddPageOverlayDocument = null;`
`97`	`97`
`98`	`98`	`private String evenPageOverlayFilename = null;`
`99`		`- private PDDocument evenPageOverlay = null;`
	`99`	`+ private PDDocument evenPageOverlayDocument = null;`
`100`	`100`
`101`	`101`	`private int numberOfOverlayPages = 0;`
`102`	`102`	`private boolean useAllOverlayPages = false;`
`@@ -174,29 +174,29 @@ public PDDocument overlayDocuments(Map<Integer, PDDocument> specificPageOverlayD`
`174`	`174`	`@Override`
`175`	`175`	`public void close() throws IOException`
`176`	`176`	`{`
`177`		`- if (defaultOverlay != null)`
	`177`	`+ if (defaultOverlayDocument != null)`
`178`	`178`	`{`
`179`		`- defaultOverlay.close();`
	`179`	`+ defaultOverlayDocument.close();`
`180`	`180`	`}`
`181`		`- if (firstPageOverlay != null)`
	`181`	`+ if (firstPageOverlayDocument != null)`
`182`	`182`	`{`
`183`		`- firstPageOverlay.close();`
	`183`	`+ firstPageOverlayDocument.close();`
`184`	`184`	`}`
`185`		`- if (lastPageOverlay != null)`
	`185`	`+ if (lastPageOverlayDocument != null)`
`186`	`186`	`{`
`187`		`- lastPageOverlay.close();`
	`187`	`+ lastPageOverlayDocument.close();`
`188`	`188`	`}`
`189`		`- if (allPagesOverlay != null)`
	`189`	`+ if (allPagesOverlayDocument != null)`
`190`	`190`	`{`
`191`		`- allPagesOverlay.close();`
	`191`	`+ allPagesOverlayDocument.close();`
`192`	`192`	`}`
`193`		`- if (oddPageOverlay != null)`
	`193`	`+ if (oddPageOverlayDocument != null)`
`194`	`194`	`{`
`195`		`- oddPageOverlay.close();`
	`195`	`+ oddPageOverlayDocument.close();`
`196`	`196`	`}`
`197`		`- if (evenPageOverlay != null)`
	`197`	`+ if (evenPageOverlayDocument != null)`
`198`	`198`	`{`
`199`		`- evenPageOverlay.close();`
	`199`	`+ evenPageOverlayDocument.close();`
`200`	`200`	`}`
`201`	`201`	`for (PDDocument doc : openDocumentsSet)`
`202`	`202`	`{`
`@@ -220,56 +220,56 @@ private void loadPDFs() throws IOException`
`220`	`220`	`// default overlay PDF`
`221`	`221`	`if (defaultOverlayFilename != null)`
`222`	`222`	`{`
`223`		`- defaultOverlay = loadPDF(defaultOverlayFilename);`
	`223`	`+ defaultOverlayDocument = loadPDF(defaultOverlayFilename);`
`224`	`224`	`}`
`225`		`- if (defaultOverlay != null)`
	`225`	`+ if (defaultOverlayDocument != null)`
`226`	`226`	`{`
`227`		`- defaultOverlayPage = createLayoutPageFromDocument(defaultOverlay);`
	`227`	`+ defaultOverlayPage = createLayoutPageFromDocument(defaultOverlayDocument);`
`228`	`228`	`}`
`229`	`229`	`// first page overlay PDF`
`230`	`230`	`if (firstPageOverlayFilename != null)`
`231`	`231`	`{`
`232`		`- firstPageOverlay = loadPDF(firstPageOverlayFilename);`
	`232`	`+ firstPageOverlayDocument = loadPDF(firstPageOverlayFilename);`
`233`	`233`	`}`
`234`		`- if (firstPageOverlay != null)`
	`234`	`+ if (firstPageOverlayDocument != null)`
`235`	`235`	`{`
`236`		`- firstPageOverlayPage = createLayoutPageFromDocument(firstPageOverlay);`
	`236`	`+ firstPageOverlayPage = createLayoutPageFromDocument(firstPageOverlayDocument);`
`237`	`237`	`}`
`238`	`238`	`// last page overlay PDF`
`239`	`239`	`if (lastPageOverlayFilename != null)`
`240`	`240`	`{`
`241`		`- lastPageOverlay = loadPDF(lastPageOverlayFilename);`
	`241`	`+ lastPageOverlayDocument = loadPDF(lastPageOverlayFilename);`
`242`	`242`	`}`
`243`		`- if (lastPageOverlay != null)`
	`243`	`+ if (lastPageOverlayDocument != null)`
`244`	`244`	`{`
`245`		`- lastPageOverlayPage = createLayoutPageFromDocument(lastPageOverlay);`
	`245`	`+ lastPageOverlayPage = createLayoutPageFromDocument(lastPageOverlayDocument);`
`246`	`246`	`}`
`247`	`247`	`// odd pages overlay PDF`
`248`	`248`	`if (oddPageOverlayFilename != null)`
`249`	`249`	`{`
`250`		`- oddPageOverlay = loadPDF(oddPageOverlayFilename);`
	`250`	`+ oddPageOverlayDocument = loadPDF(oddPageOverlayFilename);`
`251`	`251`	`}`
`252`		`- if (oddPageOverlay != null)`
	`252`	`+ if (oddPageOverlayDocument != null)`
`253`	`253`	`{`
`254`		`- oddPageOverlayPage = createLayoutPageFromDocument(oddPageOverlay);`
	`254`	`+ oddPageOverlayPage = createLayoutPageFromDocument(oddPageOverlayDocument);`
`255`	`255`	`}`
`256`	`256`	`// even pages overlay PDF`
`257`	`257`	`if (evenPageOverlayFilename != null)`
`258`	`258`	`{`
`259`		`- evenPageOverlay = loadPDF(evenPageOverlayFilename);`
	`259`	`+ evenPageOverlayDocument = loadPDF(evenPageOverlayFilename);`
`260`	`260`	`}`
`261`		`- if (evenPageOverlay != null)`
	`261`	`+ if (evenPageOverlayDocument != null)`
`262`	`262`	`{`
`263`		`- evenPageOverlayPage = createLayoutPageFromDocument(evenPageOverlay);`
	`263`	`+ evenPageOverlayPage = createLayoutPageFromDocument(evenPageOverlayDocument);`
`264`	`264`	`}`
`265`	`265`	`// all pages overlay PDF`
`266`	`266`	`if (allPagesOverlayFilename != null)`
`267`	`267`	`{`
`268`		`- allPagesOverlay = loadPDF(allPagesOverlayFilename);`
	`268`	`+ allPagesOverlayDocument = loadPDF(allPagesOverlayFilename);`
`269`	`269`	`}`
`270`		`- if (allPagesOverlay != null)`
	`270`	`+ if (allPagesOverlayDocument != null)`
`271`	`271`	`{`
`272`		`- specificPageOverlayLayoutPageMap = createPageOverlayLayoutPageMap(allPagesOverlay);`
	`272`	`+ specificPageOverlayLayoutPageMap = createPageOverlayLayoutPageMap(allPagesOverlayDocument);`
`273`	`273`	`useAllOverlayPages = true;`
`274`	`274`	`numberOfOverlayPages = specificPageOverlayLayoutPageMap.size();`
`275`	`275`	`}`
`@@ -677,7 +677,7 @@ public void setDefaultOverlayFile(String defaultOverlayFile)`
`677`	`677`	`*/`
`678`	`678`	`public void setDefaultOverlayPDF(PDDocument defaultOverlayPDF)`
`679`	`679`	`{`
`680`		`- defaultOverlay = defaultOverlayPDF;`
	`680`	`+ defaultOverlayDocument = defaultOverlayPDF;`
`681`	`681`	`}`
`682`	`682`
`683`	`683`	`/**`
`@@ -708,7 +708,7 @@ public void setFirstPageOverlayFile(String firstPageOverlayFile)`
`708`	`708`	`*/`
`709`	`709`	`public void setFirstPageOverlayPDF(PDDocument firstPageOverlayPDF)`
`710`	`710`	`{`
`711`		`- firstPageOverlay = firstPageOverlayPDF;`
	`711`	`+ firstPageOverlayDocument = firstPageOverlayPDF;`
`712`	`712`	`}`
`713`	`713`
`714`	`714`	`/**`
`@@ -729,7 +729,7 @@ public void setLastPageOverlayFile(String lastPageOverlayFile)`
`729`	`729`	`*/`
`730`	`730`	`public void setLastPageOverlayPDF(PDDocument lastPageOverlayPDF)`
`731`	`731`	`{`
`732`		`- lastPageOverlay = lastPageOverlayPDF;`
	`732`	`+ lastPageOverlayDocument = lastPageOverlayPDF;`
`733`	`733`	`}`
`734`	`734`
`735`	`735`	`/**`
`@@ -751,7 +751,7 @@ public void setAllPagesOverlayFile(String allPagesOverlayFile)`
`751`	`751`	`*/`
`752`	`752`	`public void setAllPagesOverlayPDF(PDDocument allPagesOverlayPDF)`
`753`	`753`	`{`
`754`		`- allPagesOverlay = allPagesOverlayPDF;`
	`754`	`+ allPagesOverlayDocument = allPagesOverlayPDF;`
`755`	`755`	`}`
`756`	`756`
`757`	`757`	`/**`
`@@ -772,7 +772,7 @@ public void setOddPageOverlayFile(String oddPageOverlayFile)`
`772`	`772`	`*/`
`773`	`773`	`public void setOddPageOverlayPDF(PDDocument oddPageOverlayPDF)`
`774`	`774`	`{`
`775`		`- oddPageOverlay = oddPageOverlayPDF;`
	`775`	`+ oddPageOverlayDocument = oddPageOverlayPDF;`
`776`	`776`	`}`
`777`	`777`
`778`	`778`	`/**`
`@@ -793,6 +793,6 @@ public void setEvenPageOverlayFile(String evenPageOverlayFile)`
`793`	`793`	`*/`
`794`	`794`	`public void setEvenPageOverlayPDF(PDDocument evenPageOverlayPDF)`
`795`	`795`	`{`
`796`		`- evenPageOverlay = evenPageOverlayPDF;`
	`796`	`+ evenPageOverlayDocument = evenPageOverlayPDF;`
`797`	`797`	`}`
`798`	`798`	`}`