{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

SnapshotApplyResult

public sealed class SnapshotApplyResult

Known direct subclasses

The result of a applying a mutable snapshot. Success indicates that the snapshot was successfully applied and is now visible as the global state of the state object (or visible in the parent snapshot for a nested snapshot). Failure indicates one or more state objects were modified by both this snapshot and in the global (or parent) snapshot, and the changes from this snapshot are not visible in the global or parent snapshot.

Summary

Nested types

Protected constructors

Public methods

abstract void

Check the result of an apply.

abstract boolean

True if the result is Success.

Protected constructors

SnapshotApplyResult

protected SnapshotApplyResult()

Public methods

check

public abstract void check()

Check the result of an apply. If the result is Success then this does does nothing. If the result is Failure then a SnapshotApplyConflictException exception is thrown. Once check as been called the snapshot is disposed.

getSucceeded

public abstract boolean getSucceeded()

True if the result is Success.