android-34/android/health/connect/internal/datatypes/ExerciseSessionRecordInternal.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 android.health.connect.internal.datatypes;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.health.connect.datatypes.ExerciseSessionRecord;
import android.health.connect.datatypes.ExerciseSessionType;
import android.health.connect.datatypes.Identifier;
import android.health.connect.datatypes.RecordTypeIdentifier;
import android.os.Parcel;

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

/**
 * @see ExerciseSessionRecord
 * @hide
 */
@Identifier(recordIdentifier = RecordTypeIdentifier.RECORD_TYPE_EXERCISE_SESSION)
public final class ExerciseSessionRecordInternal
        extends IntervalRecordInternal<ExerciseSessionRecord> {
    private String mNotes;
    private int mExerciseType;
    private String mTitle;
    private ExerciseRouteInternal mExerciseRoute;

    private List<ExerciseLapInternal> mExerciseLaps;

    private List<ExerciseSegmentInternal> mExerciseSegments;
    private boolean mHasRoute;

    @Nullable
    public String getNotes() {
        return mNotes;
    }

    /** returns this object with the specified notes */
    @NonNull
    public ExerciseSessionRecordInternal setNotes(String notes) {
        this.mNotes = notes;
        return this;
    }

    @ExerciseSessionType.ExerciseSessionTypes
    public int getExerciseType() {
        return mExerciseType;
    }

    /** returns this object with the specified exerciseType */
    @NonNull
    public ExerciseSessionRecordInternal setExerciseType(int exerciseType) {
        this.mExerciseType = exerciseType;
        return this;
    }

    @Nullable
    public String getTitle() {
        return mTitle;
    }

    /** returns this object with the specified title */
    @NonNull
    public ExerciseSessionRecordInternal setTitle(String title) {
        this.mTitle = title;
        return this;
    }

    /**
     * @return route of this activity
     */
    @Nullable
    public ExerciseRouteInternal getRoute() {
        return mExerciseRoute;
    }

    /** returns this object with the specified route */
    @NonNull
    public ExerciseSessionRecordInternal setRoute(ExerciseRouteInternal route) {
        this.mExerciseRoute = route;
        if (route != null) {
            this.mHasRoute = true;
        }
        return this;
    }

    /** returns if this session has route */
    public boolean hasRoute() {
        return mHasRoute;
    }

    /** returns this object with hasRoute set */
    @NonNull
    public ExerciseSessionRecordInternal setHasRoute(boolean hasRoute) {
        if (mExerciseRoute != null && !hasRoute) {
            throw new IllegalArgumentException("HasRoute must be true if the route is not null");
        }
        this.mHasRoute = hasRoute;
        return this;
    }

    /** returns laps of this session */
    @Nullable
    public List<ExerciseLapInternal> getLaps() {
        return mExerciseLaps;
    }

    /** returns this object with exercise laps set */
    public ExerciseSessionRecordInternal setExerciseLaps(
            @NonNull List<ExerciseLapInternal> exerciseLaps) {
        Objects.requireNonNull(exerciseLaps);
        mExerciseLaps = new ArrayList<>(exerciseLaps);
        return this;
    }

    @Nullable
    public List<ExerciseSegmentInternal> getSegments() {
        return mExerciseSegments;
    }

    /** returns this object with exercise segments set */
    public ExerciseSessionRecordInternal setExerciseSegments(
            @NonNull List<ExerciseSegmentInternal> exerciseSegments) {
        Objects.requireNonNull(exerciseSegments);
        mExerciseSegments = new ArrayList<>(exerciseSegments);
        return this;
    }

    @NonNull
    @Override
    public ExerciseSessionRecord toExternalRecord() {
        ExerciseSessionRecord.Builder builder =
                new ExerciseSessionRecord.Builder(
                        buildMetaData(), getStartTime(), getEndTime(), getExerciseType());

        if (getStartZoneOffset() != null) {
            builder.setStartZoneOffset(getStartZoneOffset());
        }

        if (getEndZoneOffset() != null) {
            builder.setEndZoneOffset(getEndZoneOffset());
        }

        if (getNotes() != null) {
            builder.setNotes(getNotes());
        }

        if (getTitle() != null) {
            builder.setTitle(getTitle());
        }

        if (mExerciseRoute != null) {
            builder.setRoute(mExerciseRoute.toExternalRoute());
        }

        builder.setHasRoute(mHasRoute);

        if (getLaps() != null) {
            builder.setLaps(ExerciseLapInternal.getExternalLaps(mExerciseLaps));
        }

        if (getSegments() != null) {
            builder.setSegments(ExerciseSegmentInternal.getExternalSegments(mExerciseSegments));
        }
        return builder.buildWithoutValidation();
    }

    @Override
    public void populateIntervalRecordTo(@NonNull Parcel parcel) {
        parcel.writeString(mNotes);
        parcel.writeInt(mExerciseType);
        parcel.writeString(mTitle);
        parcel.writeBoolean(mHasRoute);
        ExerciseRouteInternal.writeToParcel(mExerciseRoute, parcel);
        ExerciseLapInternal.writeLapsToParcel(mExerciseLaps, parcel);
        ExerciseSegmentInternal.writeSegmentsToParcel(mExerciseSegments, parcel);
    }

    @Override
    public void populateIntervalRecordFrom(@NonNull Parcel parcel) {
        mNotes = parcel.readString();
        mExerciseType = parcel.readInt();
        mTitle = parcel.readString();
        mHasRoute = parcel.readBoolean();
        mExerciseRoute = ExerciseRouteInternal.readFromParcel(parcel);
        mExerciseLaps = ExerciseLapInternal.populateLapsFromParcel(parcel);
        mExerciseSegments = ExerciseSegmentInternal.populateSegmentsFromParcel(parcel);
    }

    /** Add route location to the session */
    public void addRouteLocation(ExerciseRouteInternal.LocationInternal location) {
        if (mExerciseRoute == null) {
            mExerciseRoute = new ExerciseRouteInternal(List.of(location));
            mHasRoute = true;
        } else {
            mExerciseRoute.addLocation(location);
        }
    }
}