aboutsummaryrefslogtreecommitdiffstats
path: root/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangExit.java
diff options
context:
space:
mode:
authorErlang/OTP <[email protected]>2009-11-20 14:54:40 +0000
committerErlang/OTP <[email protected]>2009-11-20 14:54:40 +0000
commit84adefa331c4159d432d22840663c38f155cd4c1 (patch)
treebff9a9c66adda4df2106dfd0e5c053ab182a12bd /lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangExit.java
downloadotp-84adefa331c4159d432d22840663c38f155cd4c1.tar.gz
otp-84adefa331c4159d432d22840663c38f155cd4c1.tar.bz2
otp-84adefa331c4159d432d22840663c38f155cd4c1.zip
The R13B03 release.OTP_R13B03
Diffstat (limited to 'lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangExit.java')
-rw-r--r--lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangExit.java112
1 files changed, 112 insertions, 0 deletions
diff --git a/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangExit.java b/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangExit.java
new file mode 100644
index 0000000000..6b9015c0e5
--- /dev/null
+++ b/lib/jinterface/java_src/com/ericsson/otp/erlang/OtpErlangExit.java
@@ -0,0 +1,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;
+ }
+}