android/net/ipmemorystore/Status.java

/*
 * Copyright (C) 2018 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.net.ipmemorystore;

import android.annotation.NonNull;

import com.android.internal.annotations.VisibleForTesting;

/**
 * A parcelable status representing the result of an operation.
 * Parcels as StatusParceled.
 * @hide
 */
public class Status {
    public static final int SUCCESS = 0;

    public static final int ERROR_GENERIC = -1;
    public static final int ERROR_ILLEGAL_ARGUMENT = -2;
    public static final int ERROR_DATABASE_CANNOT_BE_OPENED = -3;
    public static final int ERROR_STORAGE = -4;
    public static final int ERROR_UNKNOWN = -5;

    public final int resultCode;

    public Status(final int resultCode) {
        this.resultCode = resultCode;
    }

    @VisibleForTesting
    public Status(@NonNull final StatusParcelable parcelable) {
        this(parcelable.resultCode);
    }

    /** Converts this Status to a parcelable object */
    @NonNull
    public StatusParcelable toParcelable() {
        final StatusParcelable parcelable = new StatusParcelable();
        parcelable.resultCode = resultCode;
        return parcelable;
    }

    public boolean isSuccess() {
        return SUCCESS == resultCode;
    }

    /** Pretty print */
    @Override
    public String toString() {
        switch (resultCode) {
            case SUCCESS: return "SUCCESS";
            case ERROR_GENERIC: return "GENERIC ERROR";
            case ERROR_ILLEGAL_ARGUMENT: return "ILLEGAL ARGUMENT";
            case ERROR_DATABASE_CANNOT_BE_OPENED: return "DATABASE CANNOT BE OPENED";
            // "DB storage error" is not very helpful but SQLite does not provide specific error
            // codes upon store failure. Thus this indicates SQLite returned some error upon store
            case ERROR_STORAGE: return "DATABASE STORAGE ERROR";
            default: return "Unknown value ?!";
        }
    }
}