UpdateMode.java

/*
 * Copyright (C) 2015 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.tools.fd.client;

import com.android.annotations.NonNull;

import static com.android.tools.fd.common.ProtocolConstants.UPDATE_MODE_COLD_SWAP;
import static com.android.tools.fd.common.ProtocolConstants.UPDATE_MODE_HOT_SWAP;
import static com.android.tools.fd.common.ProtocolConstants.UPDATE_MODE_NONE;
import static com.android.tools.fd.common.ProtocolConstants.UPDATE_MODE_WARM_SWAP;

/**
 * Mode which describes what kind of patch update we'll apply in the app: a hot swap (apply code
 * and
 * just continue running), a warm swap (restart activity), or a cold swap: a full app restart.
 */
public enum UpdateMode {
    /**
     * No updates
     */
    NO_CHANGES(UPDATE_MODE_NONE),
    /**
     * Patch changes directly, keep app running without any restarting
     */
    HOT_SWAP(UPDATE_MODE_HOT_SWAP),
    /**
     * Patch changes, restart activity to reflect changes
     */
    WARM_SWAP(UPDATE_MODE_WARM_SWAP),
    /**
     * Store change in app directory, restart app
     */
    COLD_SWAP(UPDATE_MODE_COLD_SWAP);

    private final int myId;


    UpdateMode(int id) {
        myId = id;
    }


    /**
     * The ID for this mode, which is the actual value sent across the wire to the app
     */
    public int getId() {
        return myId;
    }


    @NonNull
    public UpdateMode combine(@NonNull UpdateMode with) {
        return values()[Math.max(ordinal(), with.ordinal())];
    }
}