car-ui-lib/oem-apis/src/main/java/com/android/car/ui/plugin/oemapis/PluginVersionProviderOEMV1.java

/*
 * Copyright (C) 2020 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.car.ui.plugin.oemapis;

import android.content.Context;

/**
 * An interface for objects that support providing a list a supported versions of
 * {@link PluginFactoryOEMV1} to the app. See {@link #getPluginFactory}
 * for more information.
 */
public interface PluginVersionProviderOEMV1 {
    /**
     * Returns an object that implements {@link PluginFactoryOEMV1} or a later version.
     *
     * OEMs should aim to return the highest version of the factory possible that is <=
     * {@code maxVersion}. If the plugin is not able to provide that version,
     * it may return null, in which case car-ui-lib will fall back to it's static,
     * uncustomized implementation.
     *
     * The plugin may also choose to return different PluginFactories based on
     * certain conditions, like what type of device this is, or what app it's being used in.
     *
     * @param maxVersion The maximum version of {@link PluginFactoryOEMV1} supported by the
     *                   app.
     * @param context The plugin's context. It uses the plugin's classloader,
     *                so layout inflaters created from it can use views defined in the plugin.
     * @param packageName The package name of the app creating the plugin. Can be used
     *                    to provide per-app customizations.
     *
     * @return An object implementing {@link PluginFactoryOEMV1} for a version <=
     *         {@code maxVersion}.
     */
    Object getPluginFactory(int maxVersion, Context context, String packageName);
}