services/core/java/com/android/server/hdmi/WakeLockWrapper.java

/*
 * Copyright (C) 2023 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.hdmi;

/**
 * Interface with the methods from {@link PowerManager.WakeLock} used by the HDMI control framework.
 * Allows the class to be faked for the tests.
 *
 * See implementations {@link DefaultWakeLockWrapper} and
 * {@link FakePowerManagerWrapper.FakeWakeLockWrapper}.
 */
public interface WakeLockWrapper {

    /**
     * Wraps {@link PowerManager.WakeLock#acquire(long)};
     */
    void acquire(long timeout);

    /**
     * Wraps {@link PowerManager.WakeLock#acquire()};
     */
    void acquire();

    /**
     * Wraps {@link PowerManager.WakeLock#release()};
     */
    void release();

    /**
     * Wraps {@link PowerManager.WakeLock#isHeld()};
     */
    boolean isHeld();

    /**
     * Wraps {@link PowerManager.WakeLock#setReferenceCounted(boolean)};
     */
    void setReferenceCounted(boolean value);
}