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

Commit c5b856d0 authored by Darrell Shi's avatar Darrell Shi
Browse files

Add ComplicationType in ComplicationProvider. 

The ComplicationProvider interface now requires any implementation to
define the type(s) of the complicaiton it provides. It also converts the
type from DreamBackend to avoid dependency.

Test: atest com.android.systemui.dreams.ComplicationProviderTest
Fix: 214038720
Change-Id: Id4a41d961dbd0f3838a3a29b7524d30d7bd10b31
parent a1e7a448

packages/SystemUI/src/com/android/systemui/dreams/ComplicationProvider.java

+49 −0
Original line number Diff line number Diff line
@@ -16,14 +16,41 @@ 


package com.android.systemui.dreams;



import android.annotation.IntDef;

import android.content.Context;



import com.android.settingslib.dream.DreamBackend;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;



/**

 * {@link ComplicationProvider} is an interface for defining entities that can supply complications

 * to show over a dream. Presentation components such as the {@link DreamOverlayService} supply

 * implementations with the necessary context for constructing such overlays.

 */

public interface ComplicationProvider {

    /**

     * The type of dream complications which can be provided by a {@link ComplicationProvider}.

     */

    @IntDef(prefix = {"COMPLICATION_TYPE_"}, flag = true, value = {

            COMPLICATION_TYPE_NONE,

            COMPLICATION_TYPE_TIME,

            COMPLICATION_TYPE_DATE,

            COMPLICATION_TYPE_WEATHER,

            COMPLICATION_TYPE_AIR_QUALITY,

            COMPLICATION_TYPE_CAST_INFO

    })

    @Retention(RetentionPolicy.SOURCE)

    @interface ComplicationType {}



    int COMPLICATION_TYPE_NONE = 0;

    int COMPLICATION_TYPE_TIME = 1;

    int COMPLICATION_TYPE_DATE = 1 << 1;

    int COMPLICATION_TYPE_WEATHER = 1 << 2;

    int COMPLICATION_TYPE_AIR_QUALITY = 1 << 3;

    int COMPLICATION_TYPE_CAST_INFO = 1 << 4;



    /**

     * Called when the {@link ComplicationHost} requests the associated complication be produced.

     *
@@ -33,4 +60,26 @@ public interface ComplicationProvider { 
     */

    void onCreateComplication(Context context, ComplicationHost.CreationCallback creationCallback,

            ComplicationHost.InteractionCallback interactionCallback);



    /**

     * Converts a {@link com.android.settingslib.dream.DreamBackend.ComplicationType} to

     * {@link ComplicationType}.

     */

    @ComplicationType

    default int convertComplicationType(@DreamBackend.ComplicationType int type) {

        switch (type) {

            case DreamBackend.COMPLICATION_TYPE_TIME:

                return COMPLICATION_TYPE_TIME;

            case DreamBackend.COMPLICATION_TYPE_DATE:

                return COMPLICATION_TYPE_DATE;

            case DreamBackend.COMPLICATION_TYPE_WEATHER:

                return COMPLICATION_TYPE_WEATHER;

            case DreamBackend.COMPLICATION_TYPE_AIR_QUALITY:

                return COMPLICATION_TYPE_AIR_QUALITY;

            case DreamBackend.COMPLICATION_TYPE_CAST_INFO:

                return COMPLICATION_TYPE_CAST_INFO;

            default:

                return COMPLICATION_TYPE_NONE;

        }

    }

}

packages/SystemUI/tests/src/com/android/systemui/dreams/ComplicationProviderTest.java

0 → 100644
+66 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 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 com.android.systemui.dreams;



import static org.junit.Assert.assertEquals;



import android.content.Context;

import android.testing.AndroidTestingRunner;



import androidx.test.filters.SmallTest;



import com.android.settingslib.dream.DreamBackend;



import org.junit.Before;

import org.junit.Test;

import org.junit.runner.RunWith;



@SmallTest

@RunWith(AndroidTestingRunner.class)

public class ComplicationProviderTest {

    private TestComplicationProvider mComplicationProvider;



    @Before

    public void setup() {

        mComplicationProvider = new TestComplicationProvider();

    }



    @Test

    public void testConvertComplicationType() {

        assertEquals(ComplicationProvider.COMPLICATION_TYPE_TIME,

                mComplicationProvider.convertComplicationType(DreamBackend.COMPLICATION_TYPE_TIME));

        assertEquals(ComplicationProvider.COMPLICATION_TYPE_DATE,

                mComplicationProvider.convertComplicationType(DreamBackend.COMPLICATION_TYPE_DATE));

        assertEquals(ComplicationProvider.COMPLICATION_TYPE_WEATHER,

                mComplicationProvider.convertComplicationType(

                        DreamBackend.COMPLICATION_TYPE_WEATHER));

        assertEquals(ComplicationProvider.COMPLICATION_TYPE_AIR_QUALITY,

                mComplicationProvider.convertComplicationType(

                        DreamBackend.COMPLICATION_TYPE_AIR_QUALITY));

        assertEquals(ComplicationProvider.COMPLICATION_TYPE_CAST_INFO,

                mComplicationProvider.convertComplicationType(

                        DreamBackend.COMPLICATION_TYPE_CAST_INFO));

    }



    private static class TestComplicationProvider implements ComplicationProvider {

        @Override

        public void onCreateComplication(Context context,

                ComplicationHost.CreationCallback creationCallback,

                ComplicationHost.InteractionCallback interactionCallback) {

        }

    }

}