Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2e4269b6 authored by Kweku Adams's avatar Kweku Adams
Browse files

Add Category and Categorizer classes.

The Category is used to put UPTCs in different groups. Categorizer
returns the correct group for each UPTC.

Bug: 135764360
Test: atest CountQuotaTrackerTest
Test: atest DurationQuotaTrackerTest
Change-Id: Iab00c5b67d5b2f3a68b53e3c4d8166fe649e0f7b
parent 60cadb23
Loading
Loading
Loading
Loading
+35 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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.server.utils.quota;

import android.annotation.NonNull;
import android.annotation.Nullable;

/**
 * Identifies the {@link Category} that each UPTC belongs in.
 *
 * @see Uptc
 */
public interface Categorizer {
    /**
     * Return the {@link Category} that this UPTC belongs to.
     *
     * @see Uptc
     */
    @NonNull
    Category getCategory(int userId, @NonNull String packageName, @Nullable String tag);
}
+71 −0
Original line number Diff line number Diff line
/*
 * Copyright (C) 2019 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.server.utils.quota;

import android.annotation.NonNull;
import android.util.proto.ProtoOutputStream;
import android.util.quota.CategoryProto;

/**
 * A category as defined by the (system) client. Categories are used to put UPTCs in different
 * groups. A sample group of Categories could be the various App Standby buckets or foreground vs
 * background.
 *
 * @see Uptc
 */
public final class Category {
    @NonNull
    private final String mName;

    private final int mHash;

    /** Construct a new Category with the specified name. */
    public Category(@NonNull String name) {
        mName = name;
        mHash = name.hashCode();
    }

    /** {@inheritDoc} */
    @Override
    public boolean equals(Object other) {
        if (this == other) {
            return true;
        }
        if (other instanceof Category) {
            return this.mName.equals(((Category) other).mName);
        }
        return false;
    }

    /** {@inheritDoc} */
    @Override
    public int hashCode() {
        return mHash;
    }

    /** {@inheritDoc} */
    @Override
    public String toString() {
        return "Category{" + mName + "}";
    }

    void dumpDebug(ProtoOutputStream proto, long fieldId) {
        final long token = proto.start(fieldId);
        proto.write(CategoryProto.NAME, mName);
        proto.end(token);
    }
}