WrappedAdapter.java

/*
 *    Copyright (C) 2016 Haruki Hasegawa
 *
 *    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 com.h6ah4i.android.widget.advrecyclerview.adapter;

import android.support.v7.widget.RecyclerView;

import java.util.List;

/**
 * An interface provides better methods for wrapped adapters.
 */
public interface WrappedAdapter<VH extends RecyclerView.ViewHolder> {
    /**
     * onViewAttachedToWindow() with unwrapped item view type parameter.
     *
     * @param holder   Holder of the view being attached
     * @param viewType Unwrapped view type. Use this instead of #{{@link RecyclerView.ViewHolder#getItemViewType()}}.
     * @see {@link android.support.v7.widget.RecyclerView.Adapter#onViewAttachedToWindow(RecyclerView.ViewHolder)}
     */
    void onViewAttachedToWindow(VH holder, int viewType);

    /**
     * onViewDetachedFromWindow() with unwrapped item view type parameter.
     *
     * @param holder   Holder of the view being detached
     * @param viewType Unwrapped view type. Use this instead of #{{@link RecyclerView.ViewHolder#getItemViewType()}}.
     * @see {@link android.support.v7.widget.RecyclerView.Adapter#onViewDetachedFromWindow(RecyclerView.ViewHolder)}
     */
    void onViewDetachedFromWindow(VH holder, int viewType);

    /**
     * onViewRecycled() with unwrapped item view type parameter.
     *
     * @param holder   The ViewHolder for the view being recycled
     * @param viewType Unwrapped view type. Use this instead of #{{@link RecyclerView.ViewHolder#getItemViewType()}}.
     * @see {@link android.support.v7.widget.RecyclerView.Adapter#onViewRecycled(RecyclerView.ViewHolder)}
     */
    void onViewRecycled(VH holder, int viewType);


    /**
     * onFailedToRecycleView() with unwrapped item view type parameter.
     *
     * @param holder   The ViewHolder containing the View that could not be recycled due to its
     *                 transient state.
     * @param viewType Unwrapped view type. Use this instead of #{{@link RecyclerView.ViewHolder#getItemViewType()}}.
     * @return True if the View should be recycled, false otherwise. Note that if this method
     * returns <code>true</code>, RecyclerView <em>will ignore</em> the transient state of
     * the View and recycle it regardless. If this method returns <code>false</code>,
     * RecyclerView will check the View's transient state again before giving a final decision.
     * Default implementation returns false.
     * @see {@link android.support.v7.widget.RecyclerView.Adapter#onFailedToRecycleView(RecyclerView.ViewHolder)}
     */
    boolean onFailedToRecycleView(VH holder, int viewType);
}