summaryrefslogtreecommitdiff
path: root/android/arch/paging/NullPaddedList.java
blob: 43000302c2f3a0b4a5a974c7e73a03776787564d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
 * Copyright (C) 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 android.arch.paging;

import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.annotation.RestrictTo;

import java.util.ArrayList;
import java.util.List;

/**
 * NullPaddedList is a simple list, with optional null padding on the beginning and end.
 *
 * @param <Type> The type of the entries in the list.
 *
 * @hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public class NullPaddedList<Type> extends PagedList<Type> {
    List<Type> mList;
    int mTrailingNullCount;
    int mLeadingNullCount;
    int mPositionOffset;

    // track the items prepended/appended since the PagedList was initialized
    int mNumberPrepended;
    int mNumberAppended;

    NullPaddedList() {
    }

    @Override
    public String toString() {
        return "NullPaddedList " + mLeadingNullCount
                + ", " + mList.size()
                + ", " + mTrailingNullCount;
    }

    /**
     * Create a static, immutable NullPaddedList with the specified list,
     *
     * @param leadingNullCount Number of empty items in advance of the passed list.
     * @param list List of items.
     * @param trailingNullCount Number of empty items following the passed list.
     */
    NullPaddedList(int leadingNullCount, List<Type> list, int trailingNullCount) {
        if (leadingNullCount < 0 || trailingNullCount < 0) {
            throw new IllegalArgumentException("leading/trailing null count must be non-negative");
        }
        if (list == null) {
            throw new IllegalArgumentException("list must be non-null");
        }
        mList = list;
        mLeadingNullCount = leadingNullCount;
        mTrailingNullCount = trailingNullCount;
    }

    NullPaddedList(int leadingNullCount, int totalCount, List<Type> list) {
        if (list == null) {
            throw new IllegalArgumentException("list must be non-null");
        }

        int trailingNullCount = totalCount - (leadingNullCount) - list.size();

        mList = list;
        mLeadingNullCount = leadingNullCount;
        mTrailingNullCount = trailingNullCount;
    }

    NullPaddedList(int positionOffset, List<Type> list) {
        if (list == null) {
            throw new IllegalArgumentException("list must be non-null");
        }

        mList = list;
        mPositionOffset = positionOffset;
    }

    /**
     * Create a copy of the passed NullPaddedList.
     *
     * @param other Other list to copy.
     */
    NullPaddedList(NullPaddedList<Type> other) {
        mLeadingNullCount = other.getLeadingNullCount();
        mList = other.isImmutable() ? other.mList : new ArrayList<>(other.mList);
        mTrailingNullCount = other.getTrailingNullCount();

        mNumberPrepended = other.getNumberPrepended();
        mNumberAppended = other.getNumberAppended();
    }

    // --------------- PagedList API ---------------

    @Override
    public Type get(int index) {
        if (index < 0 || index >= size()) {
            throw new IndexOutOfBoundsException();
        }

        index -= mLeadingNullCount;
        if (index < 0) {
            return null;
        }
        if (index >= mList.size()) {
            return null;
        }
        return mList.get(index);
    }

    @Override
    public void loadAround(int index) {
        // do nothing - immutable, so no fetching will be done
    }

    @Override
    public final int size() {
        return getLoadedCount() + getLeadingNullCount() + getTrailingNullCount();
    }

    public boolean isImmutable() {
        return true;
    }

    @Override
    public PagedList<Type> snapshot() {
        if (isImmutable()) {
            return this;
        }
        return new NullPaddedList<>(this);
    }

    @Override
    boolean isContiguous() {
        return true;
    }

    @Override
    public void addWeakCallback(@Nullable PagedList<Type> previousSnapshot,
            @NonNull Callback callback) {
        // no op, immutable
    }

    @Override
    public void removeWeakCallback(Callback callback) {
        // no op, immutable
    }

    // --------------- Contiguous API ---------------

    @Override
    public int getPositionOffset() {
        return mPositionOffset;
    }

    /**
     * Number of loaded items. This does not account for leading or trailing null padding.
     *
     * @return Number of loaded items.
     */
    public int getLoadedCount() {
        return mList.size();
    }

    /**
     * Number of empty, unloaded items ahead of the loaded item region.
     *
     * @return Number of nulls before the loaded list.
     */
    public int getLeadingNullCount() {
        return mLeadingNullCount;
    }

    /**
     * Number of empty, unloaded items behind the loaded item region.
     *
     * @return Number of nulls after the loaded list.
     */
    public int getTrailingNullCount() {
        return mTrailingNullCount;
    }

    int getNumberPrepended() {
        return mNumberPrepended;
    }

    int getNumberAppended() {
        return mNumberAppended;
    }
}