/*
 * Copyright (C) 2020 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.tradefed.error;

import com.android.tradefed.result.error.ErrorIdentifier;

import java.lang.StackWalker.Option;

/**
 * Base exception class for exception thrown within the harness. This class help carry {@link
 * ErrorIdentifier} to report the failure details.
 */
public class HarnessException extends Exception implements IHarnessException {
    static final long serialVersionUID = 100L;

    private String mOrigin;
    private ErrorIdentifier mErrorId;

    public HarnessException(ErrorIdentifier errorId) {
        super();
        mErrorId = errorId;
        setCallerClass(StackWalker.getInstance(Option.RETAIN_CLASS_REFERENCE).getCallerClass());
    }

    public HarnessException(String message, ErrorIdentifier errorId) {
        super(message);
        mErrorId = errorId;
        setCallerClass(StackWalker.getInstance(Option.RETAIN_CLASS_REFERENCE).getCallerClass());
    }

    public HarnessException(Throwable cause, ErrorIdentifier errorId) {
        super(cause);
        mErrorId = errorId;
        setCallerClass(StackWalker.getInstance(Option.RETAIN_CLASS_REFERENCE).getCallerClass());
    }

    public HarnessException(String message, Throwable cause, ErrorIdentifier errorId) {
        super(message, cause);
        mErrorId = errorId;
        if (mErrorId == null && cause != null) {
            if (cause instanceof IHarnessException) {
                mErrorId = ((IHarnessException) cause).getErrorId();
            }
        }
        setCallerClass(StackWalker.getInstance(Option.RETAIN_CLASS_REFERENCE).getCallerClass());
    }

    /** Returns the {@link ErrorIdentifier} associated with the exception. Can be null. */
    @Override
    public ErrorIdentifier getErrorId() {
        return mErrorId;
    }

    /** Returns the origin of the exception. */
    @Override
    public String getOrigin() {
        return mOrigin;
    }

    protected final void setCallerClass(Class<?> clazz) {
        if (clazz != null) {
            mOrigin = clazz.getCanonicalName();
        }
    }

    protected final void setCallerClass(String clazz) {
        if (clazz != null && mOrigin == null) {
            mOrigin = clazz;
        }
    }

    @Override
    public String toString() {
        String s = getClass().getName();
        if (mErrorId != null) {
            s += "[" + mErrorId.name() + "|" + mErrorId.code() + "|" + mErrorId.status() + "]";
        }
        String message = getLocalizedMessage();
        return (message != null) ? (s + ": " + message) : s;
    }
}