aboutsummaryrefslogtreecommitdiffstats
path: root/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangExit.java
blob: f4c6f2120754f2c80935e36a0f797fc2f0ce57b3 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
 * %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:
 *
 * <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;
    }
}