/*
 * Copyright 2022 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.appsearch.localstorage.visibilitystore;

import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.RestrictTo;
import androidx.core.util.Preconditions;

/**
 * Contains attributes of an API caller relevant to its access via visibility store.
 * @exportToFramework:hide
 */
@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
public class CallerAccess {
    private final String mCallingPackageName;

    /**
     * Constructs a new {@link CallerAccess}.
     *
     * @param callingPackageName    The name of the package which wants to access data.
     */
    public CallerAccess(@NonNull String callingPackageName) {
        mCallingPackageName = Preconditions.checkNotNull(callingPackageName);
    }

    /** Returns the name of the package which wants to access data. */
    @NonNull
    public String getCallingPackageName() {
        return mCallingPackageName;
    }

    /** Returns whether the caller should have default access to data in its own package. */
    public boolean doesCallerHaveSelfAccess() {
        return true;
    }

    @Override
    public boolean equals(@Nullable Object o) {
        if (this == o) {
            return true;
        }
        if (!(o instanceof CallerAccess)) {
            return false;
        }
        CallerAccess that = (CallerAccess) o;
        return mCallingPackageName.equals(that.mCallingPackageName);
    }

    @Override
    public int hashCode() {
        return mCallingPackageName.hashCode();
    }
}