You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ja...@apache.org on 2014/12/16 04:46:11 UTC
svn commit: r1645835 -
/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Splitter.java
Author: jahewson
Date: Tue Dec 16 03:46:11 2014
New Revision: 1645835
URL: http://svn.apache.org/r1645835
Log:
PDFBOX-2396: Update JavaDoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Splitter.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Splitter.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Splitter.java?rev=1645835&r1=1645834&r2=1645835&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Splitter.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/util/Splitter.java Tue Dec 16 03:46:11 2014
@@ -135,18 +135,7 @@ public class Splitter
}
/**
- * Interface method, you can control where a document gets split by implementing
- * this method. By default a split occurs at every page. If you wanted to split
- * based on some complex logic then you could override this method. For example.
- * <code>
- * protected void createNewDocumentIfNecessary()
- * {
- * if(isPrime(pageNumber))
- * {
- * super.createNewDocumentIfNecessary();
- * }
- * }
- * </code>
+ * Helper method for creating new documents at the appropriate pages.
*
* @throws IOException If there is an error creating the new document.
*/
@@ -161,6 +150,17 @@ public class Splitter
/**
* Check if it is necessary to create a new document.
+ * By default a split occurs at every page. If you wanted to split
+ * based on some complex logic then you could override this method. For example.
+ * <code>
+ * protected void createNewDocumentIfNecessary()
+ * {
+ * if(isPrime(pageNumber))
+ * {
+ * super.createNewDocumentIfNecessary();
+ * }
+ * }
+ * </code>
*
* @return true If a new document should be created.
*/