universum.studios.android.widget.adapter

Class AdapterSavedState

java.lang.Object

universum.studios.android.widget.adapter.AdapterSavedState

All Implemented Interfaces:

Parcelable

Direct Known Subclasses:

SelectionModule.SavedState

public abstract class AdapterSavedState
extends Object
implements Parcelable

Saved state implementation for adapters like View.BaseSavedState for views. This saved state class should be used to implement saved states for all adapters that inherit from the adapter classes from the Widget Adapters library.

Author:

Martin Albedinsky

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<AdapterSavedState>	CREATOR Creator used to create an instance or array of instances of AdapterSavedState from Parcel.
static AdapterSavedState	EMPTY_STATE Empty state that should be used as return value for Adapter#saveInstanceState() whenever that specific adapter does not need to save its state.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdapterSavedState(Parcel source) Should be called from a CREATOR of a derived class to create an instance of AdapterSavedState with super state from the given parcel source.
protected	AdapterSavedState(Parcelable superState) Should be called by a derived adapter classes when creating theirs SavedState objects to allow chaining of those states via Adapter#saveInstanceState().

Method Summary

Modifier and Type	Method and Description
int	describeContents()
Parcelable	getSuperState() Returns the super state of this saved state.
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMPTY_STATE

public static final AdapterSavedState EMPTY_STATE

Empty state that should be used as return value for Adapter#saveInstanceState() whenever that specific adapter does not need to save its state.

CREATOR

public static final Parcelable.Creator<AdapterSavedState> CREATOR

Creator used to create an instance or array of instances of AdapterSavedState from Parcel.

Constructor Detail

AdapterSavedState

protected AdapterSavedState(@NonNull
                            Parcelable superState)

Should be called by a derived adapter classes when creating theirs SavedState objects to allow chaining of those states via Adapter#saveInstanceState().

Parameters:

superState - The state of the super class of the associated adapter.

AdapterSavedState

protected AdapterSavedState(@NonNull
                            Parcel source)

Should be called from a CREATOR of a derived class to create an instance of AdapterSavedState with super state from the given parcel source.

Parameters:

source - Source parcel for the new instance.

Method Detail

writeToParcel

public void writeToParcel(@NonNull
                          Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

getSuperState

@NonNull
public final Parcelable getSuperState()

Returns the super state of this saved state.

Returns:

The state supplied to AdapterSavedState(Parcelable) or a restored one via AdapterSavedState(Parcel).

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable