services/core/java/com/android/server/twilight/TwilightManager.java

   1 /*
   2  * Copyright (C) 2016 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
  17 package com.android.server.twilight;
  18
  19 import android.annotation.NonNull;
  20 import android.os.Handler;
  21
  22 /**
  23  * This class provides sunrise/sunset information based on the device's current location.
  24  */
  25 public interface TwilightManager {
  26     /**
  27      * Register a listener to be notified whenever the twilight state changes.
  28      *
  29      * @param listener the {@link TwilightListener} to be notified
  30      * @param handler the {@link Handler} to use to notify the listener
  31      */
  32     void registerListener(@NonNull TwilightListener listener, @NonNull Handler handler);
  33
  34     /**
  35      * Unregisters a previously registered listener.
  36      *
  37      * @param listener the {@link TwilightListener} to be unregistered
  38      */
  39     void unregisterListener(@NonNull TwilightListener listener);
  40
  41     /**
  42      * Returns the last {@link TwilightState}, or {@code null} if not available.
  43      */
  44     TwilightState getLastTwilightState();
  45 }