packages/SettingsLib/src/com/android/settingslib/drawer/DashboardCategory.java

/**
 * Copyright (C) 2015 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 com.android.settingslib.drawer;

import static java.lang.String.CASE_INSENSITIVE_ORDER;

import android.os.Parcel;
import android.os.Parcelable;
import android.text.TextUtils;

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

public class DashboardCategory implements Parcelable {

    /**
     * Key used for placing external tiles.
     */
    public final String key;

    /**
     * List of the category's children
     */
    private List<Tile> mTiles = new ArrayList<>();

    public DashboardCategory(String key) {
        this.key = key;
    }

    DashboardCategory(Parcel in) {
        key = in.readString();

        final int count = in.readInt();

        for (int n = 0; n < count; n++) {
            Tile tile = Tile.CREATOR.createFromParcel(in);
            mTiles.add(tile);
        }
    }

    /**
     * Get a copy of the list of the category's children.
     *
     * Note: the returned list serves as a read-only list. If tiles needs to be added or removed
     * from the actual tiles list, it should be done through {@link #addTile}, {@link #removeTile}.
     */
    public synchronized List<Tile> getTiles() {
        final List<Tile> result = new ArrayList<>(mTiles.size());
        for (Tile tile : mTiles) {
            result.add(tile);
        }
        return result;
    }

    public synchronized void addTile(Tile tile) {
        mTiles.add(tile);
    }

    public synchronized void removeTile(int n) {
        mTiles.remove(n);
    }

    public int getTilesCount() {
        return mTiles.size();
    }

    public Tile getTile(int n) {
        return mTiles.get(n);
    }

    /**
     * Sort priority value for tiles in this category.
     */
    public void sortTiles() {
        Collections.sort(mTiles, Tile.TILE_COMPARATOR);
    }

    /**
     * Sort priority value and package name for tiles in this category.
     */
    public synchronized void sortTiles(String skipPackageName) {
        // Sort mTiles based on [order, package within order]
        Collections.sort(mTiles, (tile1, tile2) -> {
            // First sort by order
            final int orderCompare = tile2.getOrder() - tile1.getOrder();
            if (orderCompare != 0) {
                return orderCompare;
            }

            // Then sort by package name, skip package take precedence
            final String package1 = tile1.getPackageName();
            final String package2 = tile2.getPackageName();
            final int packageCompare = CASE_INSENSITIVE_ORDER.compare(package1, package2);
            if (packageCompare != 0) {
                if (TextUtils.equals(package1, skipPackageName)) {
                    return -1;
                }
                if (TextUtils.equals(package2, skipPackageName)) {
                    return 1;
                }
            }
            return packageCompare;
        });
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(Parcel dest, int flags) {
        dest.writeString(key);

        final int count = mTiles.size();
        dest.writeInt(count);

        for (int n = 0; n < count; n++) {
            Tile tile = mTiles.get(n);
            tile.writeToParcel(dest, flags);
        }
    }

    public static final Creator<DashboardCategory> CREATOR = new Creator<DashboardCategory>() {
        public DashboardCategory createFromParcel(Parcel source) {
            return new DashboardCategory(source);
        }

        public DashboardCategory[] newArray(int size) {
            return new DashboardCategory[size];
        }
    };

}