MutableEditsDraft

Kotlin |Java

public final class MutableEditsDraft extends EditsDraft

java.lang.Object
↳	androidx.pdf.EditsDraft
	↳	androidx.pdf.MutableEditsDraft

A mutable builder for creating a sequence of draft edit operations.

Summary

Public constructors
`MutableEditsDraft()`

Public methods
`final void`	`insert(@NonNull PdfAnnotation annotation)` Enqueues a `insert` operation for a new `PdfAnnotation`.
`final void`	`remove(@NonNull String annotationId, int pageNum)` Enqueues a 'remove' operation for an existing annotation.
`final @NonNull EditsDraft`	`toEditsDraft()` Transforms the enqueued edits to an immutable request.
`final void`	`update(@NonNull String annotationId, @NonNull PdfAnnotation annotation)` Enqueues an 'update' operation for an existing annotation.

`boolean`	`equals(Object other)`
`int`	`hashCode()`
`final @NonNull Pair<@NonNull EditsDraft, @NonNull EditsDraft>`	`splitAt(int index)` Splits this `EditsDraft` into two separate drafts at the specified index with bounds [0, index) and [index, n).

public MutableEditsDraft()

public final void insert(@NonNull PdfAnnotation annotation)

Enqueues a insert operation for a new PdfAnnotation.

Parameters
`@NonNull PdfAnnotation annotation`	The `PdfAnnotation` to be created.

public final void remove(@NonNull String annotationId, int pageNum)

Enqueues a 'remove' operation for an existing annotation.

Parameters
`@NonNull String annotationId`	The id of the annotation to be removed.
`int pageNum`	The page number where the annotation is located.

public final @NonNull EditsDraft toEditsDraft()

Transforms the enqueued edits to an immutable request.

Returns
`@NonNull EditsDraft`	An `EditsDraft` containing the accumulated operations.

public final void update(@NonNull String annotationId, @NonNull PdfAnnotation annotation)

Enqueues an 'update' operation for an existing annotation.

Parameters
`@NonNull String annotationId`	The id of the annotation to be updated.
`@NonNull PdfAnnotation annotation`	The new `PdfAnnotation` data for the update.