ListItemProvider.java

/*
 * Copyright 2017 The Android Open Source Project
 *
 * 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 androidx.car.widget;

import androidx.annotation.NonNull;

import java.util.List;

/**
 * Supplies data as {@link ListItem}.
 *
 * @param <VH> class that extends {@link ListItem.ViewHolder}.
 */
public abstract class ListItemProvider<VH extends ListItem.ViewHolder> {

    /**
     * Returns {@link ListItem} at requested position.
     */
    public abstract @NonNull ListItem<VH> get(int position);

    /**
     * @return number of total items.
     */
    public abstract int size();

    /**
     * A simple provider that wraps around a list.
     *
     * @param <VH> class that extends {@link ListItem.ViewHolder}.
     */
    public static class ListProvider<VH extends ListItem.ViewHolder> extends ListItemProvider {
        private final List<ListItem<VH>> mItems;

        public ListProvider(@NonNull List<ListItem<VH>> items) {
            mItems = items;
        }

        @Override
        public @NonNull ListItem<VH> get(int position) {
            return mItems.get(position);
        }

        @Override
        public int size() {
            return mItems.size();
        }
    }
}