All Implemented Interfaces:


public final class Document

Represents a document.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`Document.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final <Error class: unknown class><List<Page>>`	`pagesFlow`
`private final List<Page>`	`pages`
`private String`	`uuid`
`private Long`	`creationTimeStamp`
`private Integer`	`documentImageSizeLimit`
`private final Integer`	`pageCount`
`private final Uri`	`pdfUri`
`private final Uri`	`tiffUri`
`public final static Document.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`Document(DocumentStorage documentStorage, PageFileStorage pageFileStorage, FileIOProcessor fileIOProcessor)`
`Document(DocumentStorage documentStorage, PageFileStorage pageFileStorage, FileIOProcessor fileIOProcessor, Integer documentImageSizeLimit)`
`Document(DocumentStorage documentStorage, PageFileStorage pageFileStorage, FileIOProcessor fileIOProcessor, String documentId, Boolean createIfNotExist, Integer documentImageSizeLimit)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final <Error class: unknown class><List<Page>>`	`getPagesFlow()`	The flow of pages in the document.
`final List<Page>`	`getPages()`
`final String`	`getUuid()`
`final Unit`	`setUuid(String uuid)`
`final Long`	`getCreationTimeStamp()`
`final Unit`	`setCreationTimeStamp(Long creationTimeStamp)`
`final Integer`	`getDocumentImageSizeLimit()`
`final Unit`	`setDocumentImageSizeLimit(Integer documentImageSizeLimit)`
`final Integer`	`getPageCount()`
`final Uri`	`getPdfUri()`
`final Uri`	`getTiffUri()`
`final List<String>`	`pageIds()`	Returns the list of ids of the pages.
`final Page`	`pageWithId(String uuid)`	Returns the page with the given id.
`final Page`	`pageAtIndex(Integer index)`	Returns the page with the given index.
`final Page`	`addPage(ByteArray image)`	Adds original image in the storage, and returns pageId.
`final Page`	`addPage(Bitmap image)`	Adds original image in the storage, and returns pageId.
`final Page`	`addPage(Uri imageUri)`	Adds original image in the storage, and returns pageId.
`final Page`	`insertPage(ByteArray image, Integer index)`	Inserts original image with the given index, and returns Page.
`final Page`	`insertPage(Bitmap image, Integer index)`	Inserts original image with the given index, and returns Page.
`final Boolean`	`removePage(Page page)`	Remove the given page.
`final Boolean`	`removePage(Integer atIndex)`	Remove the page with the given index.
`final Boolean`	`removePage(String pageUuid)`	Remove the page with the given id.
`final Unit`	`removeAllPages()`	Remove all page from the document at one batch operation.
`final Boolean`	`movePage(Integer sourceIndex, Integer destinationIndex)`	Move the page with the given index to the destination index.
`final Unit`	`sortPagesById(List<String> pageIds)`	Rearranges the order of pages due to order of passed Page IDs.
`final Unit`	`delete()`	Deletes the document.
`final Unit`	`saveSync()`	Saves the document synchronously.
`final Document`	`loadSync(Boolean createIfNotExist)`	Loads the document synchronously.
`final Document`	`clone()`	Creates a deep copy of the existing document with a new unique UUID, adjust JSON to new UUID and return the newly created Document.
`final Document`	`duplicate(String newUuid, Boolean overwrite)`	Copy document folder recursively under a new uuid, adjust JSON to newUuid and return the newly created Document.
`final String`	`toJson()`	Returns the JSON representation of the document.

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

- Constructor Detail
  - Document
```
Document(DocumentStorage documentStorage, PageFileStorage pageFileStorage, FileIOProcessor fileIOProcessor)
```
  - Document
```
Document(DocumentStorage documentStorage, PageFileStorage pageFileStorage, FileIOProcessor fileIOProcessor, Integer documentImageSizeLimit)
```
  - Document
```
Document(DocumentStorage documentStorage, PageFileStorage pageFileStorage, FileIOProcessor fileIOProcessor, String documentId, Boolean createIfNotExist, Integer documentImageSizeLimit)
```
- Method Detail
  - getPagesFlow
```
 final <Error class: unknown class><List<Page>> getPagesFlow()
```
    The flow of pages in the document.
  - getPages
```
 final List<Page> getPages()
```
  - getUuid
```
 final String getUuid()
```
  - setUuid
```
 final Unit setUuid(String uuid)
```
  - getCreationTimeStamp
```
 final Long getCreationTimeStamp()
```
  - setCreationTimeStamp
```
 final Unit setCreationTimeStamp(Long creationTimeStamp)
```
  - getDocumentImageSizeLimit
```
 final Integer getDocumentImageSizeLimit()
```
  - setDocumentImageSizeLimit
```
 final Unit setDocumentImageSizeLimit(Integer documentImageSizeLimit)
```
  - getPageCount
```
 final Integer getPageCount()
```
  - getPdfUri
```
 final Uri getPdfUri()
```
  - getTiffUri
```
 final Uri getTiffUri()
```
  - pageIds
```
 final List<String> pageIds()
```
    Returns the list of ids of the pages.
  - pageWithId
```
 final Page pageWithId(String uuid)
```
    Returns the page with the given id.
  - pageAtIndex
```
 final Page pageAtIndex(Integer index)
```
    Returns the page with the given index.
  - addPage
```
 final Page addPage(ByteArray image)
```
    Adds original image in the storage, and returns pageId. This is an IO operation and is not recommended to execute in the UI thread.
  - addPage
```
 final Page addPage(Bitmap image)
```
    Adds original image in the storage, and returns pageId. This is an IO operation and is not recommended to execute in the UI thread.
  - addPage
```
 final Page addPage(Uri imageUri)
```
    Adds original image in the storage, and returns pageId. This is an IO operation and is not recommended to execute in the UI thread.
    
    Parameters:
    
    imageUri - the file URI of the image to be added.
  - insertPage
```
 final Page insertPage(ByteArray image, Integer index)
```
    Inserts original image with the given index, and returns Page. This is an IO operation and is not recommended to execute in the UI thread.
  - insertPage
```
 final Page insertPage(Bitmap image, Integer index)
```
    Inserts original image with the given index, and returns Page. This is an IO operation and is not recommended to execute in the UI thread.
  - removePage
```
 final Boolean removePage(Page page)
```
    Remove the given page. This is an IO operation and is not recommended to execute in the UI thread.
  - removePage
```
 final Boolean removePage(Integer atIndex)
```
    Remove the page with the given index. This is an IO operation and is not recommended to execute in the UI thread.
  - removePage
```
 final Boolean removePage(String pageUuid)
```
    Remove the page with the given id. This is an IO operation and is not recommended to execute in the UI thread.
  - removeAllPages
```
 final Unit removeAllPages()
```
    Remove all page from the document at one batch operation. This is an IO operation and is not recommended to execute in the UI thread.
  - movePage
```
 final Boolean movePage(Integer sourceIndex, Integer destinationIndex)
```
    Move the page with the given index to the destination index. This is an IO operation and is not recommended to execute in the UI thread.
  - sortPagesById
```
 final Unit sortPagesById(List<String> pageIds)
```
    Rearranges the order of pages due to order of passed Page IDs. This is an IO operation and is not recommended to execute in the UI thread.
  - delete
```
 final Unit delete()
```
    Deletes the document. This is an IO operation and is not recommended to execute in the UI thread.
  - saveSync
```
 final Unit saveSync()
```
    Saves the document synchronously. This is an IO operation and is not recommended to execute in the UI thread.
  - loadSync
```
 final Document loadSync(Boolean createIfNotExist)
```
    Loads the document synchronously. This is an IO operation and is not recommended to execute in the UI thread.
  - clone
```
 final Document clone()
```
    Creates a deep copy of the existing document with a new unique UUID, adjust JSON to new UUID and return the newly created Document. Creates a deep copy of the each page with a new unique UUIDs. This is an IO operation and is not recommended to execute in the UI thread.
  - duplicate
```
 final Document duplicate(String newUuid, Boolean overwrite)
```
    Copy document folder recursively under a new uuid, adjust JSON to newUuid and return the newly created Document. Creates a deep copy of the each page with a new unique UUIDs. This is an IO operation and is not recommended to execute in the UI thread.
  - toJson
```
 final String toJson()
```
    Returns the JSON representation of the document.

Class Document

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Document

Document

Document

Method Detail

getPagesFlow

getPages

getUuid

setUuid

getCreationTimeStamp

setCreationTimeStamp

getDocumentImageSizeLimit

setDocumentImageSizeLimit

getPageCount

getPdfUri

getTiffUri

pageIds

pageWithId

pageAtIndex

addPage

addPage

addPage

insertPage

insertPage

removePage

removePage

removePage

removeAllPages

movePage

sortPagesById

delete

saveSync

loadSync

clone

duplicate

toJson