1 /*
2  * Copyright (C) 2024 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package com.android.bedstead.harrier;
17 
18 /**
19  * Interface used by classes which respond to key events in DeviceState
20  * These classes must be loaded in {@link BedsteadServiceLocator} to receive the callbacks
21  */
22 // This is written in Java because Kotlin interfaces can't expose default methods to Java
23 public interface DeviceStateComponent {
24     /**
25      * Restore the previous state of any shareable changes.
26      */
teardownShareableState()27     default void teardownShareableState() {}
28 
29     /**
30      * Restore the previous state of any non-shareable changes.
31      */
teardownNonShareableState()32     default void teardownNonShareableState() {}
33 
34     /**
35      * Prepare component for test
36      */
prepareTestState()37     default void prepareTestState() {}
38 
39     /**
40      * See {@link HarrierRule#releaseResources()}
41      */
releaseResources()42     default void releaseResources() {}
43 }
44