core/java/android/app/time/UnixEpochTime.java

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

import android.annotation.CurrentTimeMillisLong;
import android.annotation.ElapsedRealtimeLong;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.SystemApi;
import android.os.Parcel;
import android.os.Parcelable;
import android.os.ShellCommand;
import android.os.SystemClock;

import java.io.PrintWriter;
import java.util.Objects;

/**
 * A Unix epoch time value with an associated reading from the elapsed realtime clock.
 * When representing a device's system clock time, the Unix epoch time can be obtained using {@link
 * System#currentTimeMillis()}. The Unix epoch time might also come from an external source
 * depending on usage.
 *
 * <p>The elapsed realtime clock can be obtained using methods like {@link
 * SystemClock#elapsedRealtime()} or {@link SystemClock#elapsedRealtimeClock()}.
 *
 * @hide
 */
@SystemApi
public final class UnixEpochTime implements Parcelable {
    @ElapsedRealtimeLong private final long mElapsedRealtimeMillis;
    @CurrentTimeMillisLong private final long mUnixEpochTimeMillis;

    public UnixEpochTime(@ElapsedRealtimeLong long elapsedRealtimeMillis,
            long unixEpochTimeMillis) {
        mElapsedRealtimeMillis = elapsedRealtimeMillis;
        mUnixEpochTimeMillis = unixEpochTimeMillis;
    }

    /** @hide */
    @NonNull
    public static UnixEpochTime parseCommandLineArgs(ShellCommand cmd) {
        Long elapsedRealtimeMillis = null;
        Long unixEpochTimeMillis = null;
        String opt;
        while ((opt = cmd.getNextArg()) != null) {
            switch (opt) {
                case "--elapsed_realtime": {
                    elapsedRealtimeMillis = Long.parseLong(cmd.getNextArgRequired());
                    break;
                }
                case "--unix_epoch_time": {
                    unixEpochTimeMillis = Long.parseLong(cmd.getNextArgRequired());
                    break;
                }
                default: {
                    throw new IllegalArgumentException("Unknown option: " + opt);
                }
            }
        }

        if (elapsedRealtimeMillis == null) {
            throw new IllegalArgumentException("No elapsedRealtimeMillis specified.");
        }
        if (unixEpochTimeMillis == null) {
            throw new IllegalArgumentException("No unixEpochTimeMillis specified.");
        }
        return new UnixEpochTime(elapsedRealtimeMillis, unixEpochTimeMillis);
    }

    /** @hide */
    public static void printCommandLineOpts(PrintWriter pw) {
        pw.println("UnixEpochTime options:\n");
        pw.println("  --elapsed_realtime <elapsed realtime millis>");
        pw.println("  --unix_epoch_time <Unix epoch time millis>");
        pw.println();
        pw.println("See " + UnixEpochTime.class.getName() + " for more information");
    }

    /** Returns the elapsed realtime clock value. See {@link UnixEpochTime} for more information. */
    @ElapsedRealtimeLong
    public long getElapsedRealtimeMillis() {
        return mElapsedRealtimeMillis;
    }

    /** Returns the unix epoch time value. See {@link UnixEpochTime} for more information. */
    @CurrentTimeMillisLong
    public long getUnixEpochTimeMillis() {
        return mUnixEpochTimeMillis;
    }

    @Override
    public boolean equals(@Nullable Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        UnixEpochTime that = (UnixEpochTime) o;
        return mElapsedRealtimeMillis == that.mElapsedRealtimeMillis
                && mUnixEpochTimeMillis == that.mUnixEpochTimeMillis;
    }

    @Override
    public int hashCode() {
        return Objects.hash(mElapsedRealtimeMillis, mUnixEpochTimeMillis);
    }

    @Override
    public String toString() {
        return "UnixEpochTime{"
                + "mElapsedRealtimeMillis=" + mElapsedRealtimeMillis
                + ", mUnixEpochTimeMillis=" + mUnixEpochTimeMillis
                + '}';
    }

    public static final @NonNull Creator<UnixEpochTime> CREATOR = new Creator<>() {
        @Override
        public UnixEpochTime createFromParcel(@NonNull Parcel source) {
            long elapsedRealtimeMillis = source.readLong();
            long unixEpochTimeMillis = source.readLong();
            return new UnixEpochTime(elapsedRealtimeMillis, unixEpochTimeMillis);
        }

        @Override
        public UnixEpochTime[] newArray(int size) {
            return new UnixEpochTime[size];
        }
    };

    @Override
    public void writeToParcel(@NonNull Parcel dest, int flags) {
        dest.writeLong(mElapsedRealtimeMillis);
        dest.writeLong(mUnixEpochTimeMillis);
    }

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

    /**
     * Creates a new Unix epoch time value at {@code elapsedRealtimeTimeMillis} by adjusting this
     * Unix epoch time by the difference between the elapsed realtime value supplied and the one
     * associated with this instance.
     */
    @NonNull
    public UnixEpochTime at(@ElapsedRealtimeLong long elapsedRealtimeTimeMillis) {
        long adjustedUnixEpochTimeMillis =
                (elapsedRealtimeTimeMillis - mElapsedRealtimeMillis) + mUnixEpochTimeMillis;
        return new UnixEpochTime(elapsedRealtimeTimeMillis, adjustedUnixEpochTimeMillis);
    }

    /**
     * Returns the difference in milliseconds between two instance's elapsed realtimes.
     *
     * @hide
     */
    public static long elapsedRealtimeDifference(
            @NonNull UnixEpochTime one, @NonNull UnixEpochTime two) {
        return one.mElapsedRealtimeMillis - two.mElapsedRealtimeMillis;
    }
}