OkioSerializer
public interface OkioSerializer<T extends Object>
PreferencesSerializer |
Proto based serializer for Preferences. |
The OkioSerializer determines the on-disk format and API for accessing it.
The type T MUST be immutable. Mutable types will result in broken DataStore functionality.
Summary
Public methods |
|
|---|---|
abstract @NonNull T |
Value to return if there is no data on disk. |
abstract @NonNull T |
readFrom(@NonNull BufferedSource source)Unmarshal object from source. |
abstract void |
writeTo(@NonNull T t, @NonNull BufferedSink sink)Marshal object to a Sink. |
Public methods
getDefaultValue
Added in 1.1.1
abstract @NonNull T getDefaultValue()
Value to return if there is no data on disk.
readFrom
abstract @NonNull T readFrom(@NonNull BufferedSource source)
Unmarshal object from source.
| Parameters | |
|---|---|
@NonNull BufferedSource source |
the BufferedSource with the data to deserialize |
writeTo
Added in 1.1.1
abstract void writeTo(@NonNull T t, @NonNull BufferedSink sink)
Marshal object to a Sink.
| Parameters | |
|---|---|
@NonNull T t |
the data to write to output |
@NonNull BufferedSink sink |
the BufferedSink to serialize data to |