PageOptions (Mindee Java Helper Library 4.33.0 API)

java.lang.Object
- com.mindee.input.PageOptions

public final class PageOptions
extends Object

Represent options to cut a document.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class PageOptions.Builder
Builder for page options.

Constructor Summary

Constructors
Constructor	Description
`PageOptions(List<Integer> pages)`	Deprecated. Use the Builder pattern instead.
`PageOptions(List<Integer> pages, PageOptionsOperation operation)`	Deprecated. Use the Builder pattern instead.
`PageOptions(List<Integer> pageIndexes, PageOptionsOperation operation, Integer onMinPages)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object o)`
`Integer`	`getOnMinPages()`	Apply the operation only if the document has at least this many pages. 0 by default.
`PageOptionsOperation`	`getOperation()`	Operation to apply on the document, given the `pageIndexes` specified.
`List<Integer>`	`getPageIndexes()`	Zero-based list of page indexes.
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PageOptions
```
@Deprecated
public PageOptions(List<Integer> pages)
```
    Deprecated.
    Use the Builder pattern instead.
  - PageOptions
```
@Deprecated
public PageOptions(List<Integer> pages,
                   PageOptionsOperation operation)
```
    Deprecated.
    Use the Builder pattern instead.
  - PageOptions
```
public PageOptions(List<Integer> pageIndexes,
                   PageOptionsOperation operation,
                   Integer onMinPages)
```
- Method Detail
  - getPageIndexes
```
public List<Integer> getPageIndexes()
```
    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.
  - getOperation
```
public PageOptionsOperation getOperation()
```
    Operation to apply on the document, given the `pageIndexes` specified. `KeepOnly` by default.
  - getOnMinPages
```
public Integer getOnMinPages()
```
    Apply the operation only if the document has at least this many pages. 0 by default.
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object