/*
 * %CopyrightBegin%
 *
 * Copyright Ericsson AB 2000-2009. All Rights Reserved.
 *
 * 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.
 *
 * %CopyrightEnd%
 */
package com.ericsson.otp.erlang;

/**
 * Exception raised when a communication channel is broken. This can be caused
 * for a number of reasons, for example:
 *
 * <ul>
 * <li>an error in communication has occurred
 * <li>a remote process has sent an exit signal
 * <li>a linked process has exited
 * </ul>
 *
 * @see OtpConnection
 */

public class OtpErlangExit extends OtpErlangException {
    private static final long serialVersionUID = 1L;

    OtpErlangObject reason = null;
    OtpErlangPid pid = null;

    /**
     * Create an OtpErlangExit exception with the given reason.
     *
     * @param reason
     *            the reason this exit signal has been sent.
     */
    public OtpErlangExit(final OtpErlangObject reason) {
        super(reason.toString());
        this.reason = reason;
    }

    /**
     * <p>
     * Equivalent to <code>OtpErlangExit(new
     * OtpErlangAtom(reason)</code>.
     * </p>
     *
     * @param reason
     *            the reason this exit signal has been sent.
     *
     * @see #OtpErlangExit(OtpErlangObject)
     */
    public OtpErlangExit(final String reason) {
        this(new OtpErlangAtom(reason));
    }

    /**
     * Create an OtpErlangExit exception with the given reason and sender pid.
     *
     * @param reason
     *            the reason this exit signal has been sent.
     *
     * @param pid
     *            the pid that sent this exit.
     */
    public OtpErlangExit(final OtpErlangObject reason, final OtpErlangPid pid) {
        super(reason.toString());
        this.reason = reason;
        this.pid = pid;
    }

    /**
     * <p>
     * Equivalent to <code>OtpErlangExit(new OtpErlangAtom(reason),
     * pid)</code>.
     * </p>
     *
     * @param reason
     *            the reason this exit signal has been sent.
     *
     * @param pid
     *            the pid that sent this exit.
     *
     * @see #OtpErlangExit(OtpErlangObject, OtpErlangPid)
     */
    public OtpErlangExit(final String reason, final OtpErlangPid pid) {
        this(new OtpErlangAtom(reason), pid);
    }

    /**
     * Get the reason associated with this exit signal.
     */
    public OtpErlangObject reason() {
        return reason;
    }

    /**
     * Get the pid that sent this exit.
     */
    public OtpErlangPid pid() {
        return pid;
    }
}
