pdfbox-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From til...@apache.org
Subject svn commit: r1759499 - /pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java
Date Tue, 06 Sep 2016 20:01:34 GMT
Author: tilman
Date: Tue Sep  6 20:01:33 2016
New Revision: 1759499

URL: http://svn.apache.org/viewvc?rev=1759499&view=rev
Log:
PDFBOX-2852: clarify javadoc

Modified:
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java?rev=1759499&r1=1759498&r2=1759499&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDPage.java Tue Sep
 6 20:01:33 2016
@@ -650,10 +650,11 @@ public class PDPage implements COSObject
     }
 
     /**
-     * This will get a list of PDThreadBead objects, which are article threads in the
-     * document.  This will return an empty list if there are no thread beads.
+     * This will get a list of PDThreadBead objects, which are article threads in the document.
This
+     * will return an empty list if there are no thread beads.
      *
-     * @return A list of article threads on this page.
+     * @return A list of article threads on this page, never null. The returned list is backed
by
+     * the beads COSArray, so any adding or deleting in this list will change the document
too.
      */
     public List<PDThreadBead> getThreadBeads()
     {
@@ -675,7 +676,6 @@ public class PDPage implements COSObject
             pdObjects.add( bead );
         }
         return new COSArrayList<PDThreadBead>(pdObjects, beads);
-
     }
 
     /**



Mime
View raw message