com.ericsson.otp.erlang.OtpErlangExit Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jinterface Show documentation

Jinterface Java package contains java classes, which help you integrate programs written in Java with Erlang. Erlang is a programming language designed at the Ericsson Computer Science Laboratory.

There is a newer version: 1.6.1

Show newest version

/*
 * %CopyrightBegin%
 * 
 * Copyright Ericsson AB 2000-2009. All Rights Reserved.
 * 
 * The contents of this file are subject to the Erlang Public License,
 * Version 1.1, (the "License"); you may not use this file except in
 * compliance with the License. You should have received a copy of the
 * Erlang Public License along with this software. If not, it can be
 * retrieved online at http://www.erlang.org/.
 * 
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights 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:
 * 
 * 
 *  an error in communication has occurred
 * 
 a remote process has sent an exit signal
 * 
 a linked process has exited
 * 
 * 
 * @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;
    }

    /**
     * 
     * Equivalent to OtpErlangExit(new
     * OtpErlangAtom(reason).
     * 
     * 
     * @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;
    }

    /**
     * 
     * Equivalent to OtpErlangExit(new OtpErlangAtom(reason),
     * pid).
     * 
     * 
     * @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;
    }
}