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

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

import android.text.format.DateFormat;

import java.util.Calendar;

/**
 * The twilight state, consisting of the sunrise and sunset times (in millis) for the current
 * period.
 * <p/>
 * Note: This object is immutable.
 */
public final class TwilightState {

    private final long mSunriseTimeMillis;
    private final long mSunsetTimeMillis;

    public TwilightState(long sunriseTimeMillis, long sunsetTimeMillis) {
        mSunriseTimeMillis = sunriseTimeMillis;
        mSunsetTimeMillis = sunsetTimeMillis;
    }

    /**
     * Returns the time (in UTC milliseconds from epoch) of the upcoming or previous sunrise if
     * it's night or day respectively.
     */
    public long sunriseTimeMillis() {
        return mSunriseTimeMillis;
    }

    /**
     * Returns a new {@link Calendar} instance initialized to {@link #sunriseTimeMillis()}.
     */
    public Calendar sunrise() {
        final Calendar sunrise = Calendar.getInstance();
        sunrise.setTimeInMillis(mSunriseTimeMillis);
        return sunrise;
    }

    /**
     * Returns the time (in UTC milliseconds from epoch) of the upcoming or previous sunset if
     * it's day or night respectively.
     */
    public long sunsetTimeMillis() {
        return mSunsetTimeMillis;
    }

    /**
     * Returns a new {@link Calendar} instance initialized to {@link #sunsetTimeMillis()}.
     */
    public Calendar sunset() {
        final Calendar sunset = Calendar.getInstance();
        sunset.setTimeInMillis(mSunsetTimeMillis);
        return sunset;
    }

    /**
     * Returns {@code true} if it is currently night time.
     */
    public boolean isNight() {
        final long now = System.currentTimeMillis();
        return now >= mSunsetTimeMillis && now < mSunriseTimeMillis;
    }

    @Override
    public boolean equals(Object o) {
        return o instanceof TwilightState && equals((TwilightState) o);
    }

    public boolean equals(TwilightState other) {
        return other != null
                && mSunriseTimeMillis == other.mSunriseTimeMillis
                && mSunsetTimeMillis == other.mSunsetTimeMillis;
    }

    @Override
    public int hashCode() {
        return Long.hashCode(mSunriseTimeMillis) ^ Long.hashCode(mSunsetTimeMillis);
    }

    @Override
    public String toString() {
        return "TwilightState {"
                + " sunrise=" + DateFormat.format("MM-dd HH:mm", mSunriseTimeMillis)
                + " sunset="+ DateFormat.format("MM-dd HH:mm", mSunsetTimeMillis)
                + " }";
    }
}