paperparcel.TypeAdapter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of paperparcel-api Show documentation

Android Parcelable boilerplate annotation processor

There is a newer version: 2.0.8

/*
 * Copyright (C) 2016 Bradley Campbell.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package paperparcel;

import android.os.Parcel;
import android.support.annotation.NonNull;

/**
 * A custom method for reading and writing a type using {@link Parcel}.
 *
 * When defining a {@code TypeAdapter}, you may choose to handle {@code null} values or not. If
 * you choose not to, PaperParcel will handle the null-safety for you automatically. If you choose
 * to handle {@code null} values (or the adapted type can never be {@code null}), then you should
 * set {@link Adapter#nullSafe()} to {@code true}.
 *
 * @param  The Type to override the default reading/writing functionality for
 *
 * @see Adapter#nullSafe()
 */
public interface TypeAdapter {

  /**
   * Creates a new instance of the desired Type by reading values from the Parcel {@code inParcel}
   *
   * @param source The {@link Parcel} which contains the values of {@code T}
   * @return       A new object based on the values in {@code inParcel}.
   */
   T readFromParcel(@NonNull Parcel source);

  /**
   * Writes {@code value} to the Parcel {@code outParcel}.
   *
   * @param value The object to be written to the {@link Parcel}
   * @param dest  The {@link Parcel} which will contain the value of {@code T}
   * @param flags Additional flags about how the object should be written. May be 0 or
   *              {@link android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE}.
   */
  void writeToParcel(T value, @NonNull Parcel dest, int flags);
}