src.android.app.timedetector.NetworkTimeSuggestion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of android-all Show documentation
A library jar that provides APIs for Applications written for the Google Android Platform.
There is a newer version: 15-robolectric-12650502
/*
 * Copyright (C) 2019 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 android.app.timedetector;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.os.Parcel;
import android.os.Parcelable;
import android.os.TimestampedValue;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * A time signal from a network time source like NTP.
 *
 * {@code unixEpochTime} contains the suggested time. The {@code unixEpochTime.value} is the
 * number of milliseconds elapsed since 1/1/1970 00:00:00 UTC according to the Unix time system.
 * The {@code unixEpochTime.referenceTimeMillis} is the value of the elapsed realtime clock when
 * the {@code unixEpochTime.value} was established. Note that the elapsed realtime clock is
 * considered accurate but it is volatile, so time suggestions cannot be persisted across device
 * resets.
 *
 * {@code debugInfo} contains debugging metadata associated with the suggestion. This is used to
 * record why the suggestion exists and how it was determined. This information exists only to aid
 * in debugging and therefore is used by {@link #toString()}, but it is not for use in detection
 * logic and is not considered in {@link #hashCode()} or {@link #equals(Object)}.
 *
 * @hide
 */
public final class NetworkTimeSuggestion implements Parcelable {

    public static final @NonNull Creator CREATOR =
            new Creator() {
                public NetworkTimeSuggestion createFromParcel(Parcel in) {
                    return NetworkTimeSuggestion.createFromParcel(in);
                }

                public NetworkTimeSuggestion[] newArray(int size) {
                    return new NetworkTimeSuggestion[size];
                }
            };

    @NonNull private final TimestampedValue mUnixEpochTime;
    @Nullable private ArrayList mDebugInfo;

    public NetworkTimeSuggestion(@NonNull TimestampedValue unixEpochTime) {
        mUnixEpochTime = Objects.requireNonNull(unixEpochTime);
        Objects.requireNonNull(unixEpochTime.getValue());
    }

    private static NetworkTimeSuggestion createFromParcel(Parcel in) {
        TimestampedValue unixEpochTime =
                in.readParcelable(null /* classLoader */, android.os.TimestampedValue.class);
        NetworkTimeSuggestion suggestion = new NetworkTimeSuggestion(unixEpochTime);
        @SuppressWarnings("unchecked")
        ArrayList debugInfo = (ArrayList) in.readArrayList(
                null /* classLoader */, java.lang.String.class);
        suggestion.mDebugInfo = debugInfo;
        return suggestion;
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        dest.writeParcelable(mUnixEpochTime, 0);
        dest.writeList(mDebugInfo);
    }

    @NonNull
    public TimestampedValue getUnixEpochTime() {
        return mUnixEpochTime;
    }

    @NonNull
    public List getDebugInfo() {
        return mDebugInfo == null
                ? Collections.emptyList() : Collections.unmodifiableList(mDebugInfo);
    }

    /**
     * Associates information with the instance that can be useful for debugging / logging. The
     * information is present in {@link #toString()} but is not considered for
     * {@link #equals(Object)} and {@link #hashCode()}.
     */
    public void addDebugInfo(String... debugInfos) {
        if (mDebugInfo == null) {
            mDebugInfo = new ArrayList<>();
        }
        mDebugInfo.addAll(Arrays.asList(debugInfos));
    }

    @Override
    public boolean equals(@Nullable Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        NetworkTimeSuggestion that = (NetworkTimeSuggestion) o;
        return Objects.equals(mUnixEpochTime, that.mUnixEpochTime);
    }

    @Override
    public int hashCode() {
        return Objects.hash(mUnixEpochTime);
    }

    @Override
    public String toString() {
        return "NetworkTimeSuggestion{"
                + "mUnixEpochTime=" + mUnixEpochTime
                + ", mDebugInfo=" + mDebugInfo
                + '}';
    }
}