Skip to content

📝 fix documentation of page options #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ianardee merged 2 commits into from
Aug 4, 2025
Merged

📝 fix documentation of page options #264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fd95b7d
:memo: fix documentation of page options
ianardee Aug 1, 2025
c5805fd
Merge branch 'main' into adjust-page-options
ianardee Aug 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/main/java/com/mindee/input/PageOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public class PageOptions {
/**
* Zero-based list of page indexes.
* A negative index can be used, indicating an offset from the end of the document.
* [1, -1] represents the first and last pages of the document.
* [0, -1] represents the first and last pages of the document.
*/
List<Integer> pageIndexes;
/**
Expand Down
12 changes: 6 additions & 6 deletions src/test/java/com/mindee/pdf/PdfOperationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public void givenADocumentAndPageToKeep_whenSplit_thenReturnsOnlyKeptPage()
throws IOException {

PageOptions pageOptions = new PageOptions.Builder()
.pageIndexes(new Integer[]{2})
.pageIndexes(new Integer[]{ 2 })
.operation(PageOptionsOperation.KEEP_ONLY)
.build();

Expand All @@ -42,8 +42,8 @@ public void givenADocumentAndListOfPagesToKeep_whenSplit_thenReturnsOnlyKeptPage
throws IOException {

List<Integer> pageNumbersToKeep = new ArrayList<>();
pageNumbersToKeep.add(0);
pageNumbersToKeep.add(1);
pageNumbersToKeep.add(2);

PageOptions pageOptions = new PageOptions.Builder()
.pageIndexes(pageNumbersToKeep)
Expand All @@ -66,7 +66,7 @@ public void givenADocumentAndListOfPagesToRemove_whenSplit_thenReturnsOnlyNotRem
throws IOException {

PageOptions pageOptions = new PageOptions.Builder()
.pageIndexes(new Integer[]{1,2,3})
.pageIndexes(new Integer[]{ 0,1,2 })
.operation(PageOptionsOperation.REMOVE)
.build();

Expand All @@ -86,7 +86,7 @@ public void givenADocumentOtherThantAPdf_whenSplit_mustFail()
throws IOException {

PageOptions pageOptions = new PageOptions.Builder()
.pageIndexes(new Integer[]{1,2,3})
.pageIndexes(new Integer[]{ 1,2,3 })
.operation(PageOptionsOperation.REMOVE)
.build();

Expand All @@ -105,7 +105,7 @@ public void givenADocumentAndListPagesToRemoveAndMinPagesCondition_whenSplit_mus
throws IOException {

PageOptions pageOptions = new PageOptions.Builder()
.pageIndexes(new Integer[]{1})
.pageIndexes(new Integer[]{ 0 })
.operation(PageOptionsOperation.REMOVE)
.onMinPages(5)
.build();
Expand All @@ -126,7 +126,7 @@ public void givenADocumentAndNegativeListPagesToKeep_whenSplit_thenReturnsOnlyKe
throws IOException {

PageOptions pageOptions = new PageOptions.Builder()
.pageIndexes(new Integer[]{1,-2,-1})
.pageIndexes(new Integer[]{ 0,-2,-1 })
.operation(PageOptionsOperation.KEEP_ONLY)
.build();

Expand Down
Loading