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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/**
* Copyright 2015 JogAmp Community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are
* permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice, this list
* of conditions and the following disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
* FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* The views and conclusions contained in the software and documentation are those of the
* authors and should not be interpreted as representing official policies, either expressed
* or implied, of JogAmp Community.
*/
package com.jogamp.common.util;
import java.io.PrintStream;
import com.jogamp.common.ExceptionUtils;
import com.jogamp.common.ExceptionUtils.CustomStackTrace;
/**
* {@link InterruptedException}, which may include the source, see {@link #getInterruptSource()}.
* <p>
* This exception may be created directly where {@link #getCause()} returns {@code null},
* or by propagating an existing {@link InterruptedException} as returned by {@link #getCause()}.
* </p>
* @since 2.3.2
*/
@SuppressWarnings("serial")
public class SourcedInterruptedException extends InterruptedException implements CustomStackTrace {
final Throwable interruptSource;
/**
* Wraps the given {@link InterruptedException} into a {@link SourcedInterruptedException}
* if it is not yet of the desired type and
* if the current thread if a {@link InterruptSource}, i.e. the source is known.
* <p>
* Otherwise the given {@link InterruptedException} instance is returned.
* </p>
* <p>
* In case method is creating a new wrapping instance,
* {@link InterruptSource#clearInterruptSource()} is being issued.
* </p>
*
* @param ie the to be wrapped {@link InterruptedException}
*/
public static InterruptedException wrap(final InterruptedException ie) {
return wrap(ie, InterruptSource.Util.currentThread());
}
/**
* Wraps the given {@link InterruptedException} into a {@link SourcedInterruptedException}
* if it is not yet of the same type and if {@code source} is not {@code null}.
* <p>
* Otherwise the given {@link InterruptedException} instance is returned.
* </p>
* <p>
* In case method is creating a new wrapping instance,
* {@link InterruptSource#clearInterruptSource()} is being issued.
* </p>
*
* @param ie the to be wrapped {@link InterruptedException}
* @param source the {@link InterruptSource}
*/
public static InterruptedException wrap(final InterruptedException ie, final InterruptSource source) {
if( !(ie instanceof SourcedInterruptedException) && null != source ) {
return new SourcedInterruptedException(ie, source.getInterruptSource(true));
} else {
return ie;
}
}
/**
* @param message mandatory message of this exception
* @param cause optional propagated cause
* @param interruptSource optional propagated source of {@link Thread#interrupt()} call
*/
public SourcedInterruptedException(final String message, final InterruptedException cause, final Throwable interruptSource) {
super(message);
if( null != cause ) {
initCause(cause);
}
this.interruptSource = interruptSource;
}
/**
* @param cause mandatory propagated cause
* @param interruptSource optional propagated source of {@link Thread#interrupt()} call
*/
public SourcedInterruptedException(final InterruptedException cause, final Throwable interruptSource) {
super(cause.getMessage());
initCause(cause);
this.interruptSource = interruptSource;
}
/**
* Returns the source of the {@link Thread#interrupt()} call if known,
* otherwise {@code null} is returned.
*/
public final Throwable getInterruptSource() {
return interruptSource;
}
/**
* Returns the propagated {@link InterruptedException}, i.e. the cause of this exception,
* or {@code null} if not applicable.
* <p>
* {@inheritDoc}
* </p>
*/
@Override
public InterruptedException getCause() {
return (InterruptedException)super.getCause();
}
@Override
public String toString() {
final StringBuilder sb = new StringBuilder(256);
sb.append(getClass().getSimpleName()).append(": ");
if (null != interruptSource) {
sb.append("[sourced]");
} else {
sb.append("[unknown]");
}
final String m = getLocalizedMessage();
if( null != m ) {
sb.append(" ").append(m);
}
return sb.toString();
}
@Override
public final void dumpCauseStack(final PrintStream s, final String causeStr, final int causeDepth) {
final String s0 = causeStr+"["+causeDepth+"]";
s.println(s0+" by "+getClass().getSimpleName()+": "+getMessage()+" on thread "+Thread.currentThread().getName());
ExceptionUtils.dumpStack(s, getStackTrace(), 0, -1);
if( null != interruptSource ) {
ExceptionUtils.dumpCause(s, s0, interruptSource, 1);
}
}
@Override
public final void printStackTrace(final PrintStream s) {
s.println(getClass().getSimpleName()+": "+getMessage()+" on thread "+Thread.currentThread().getName());
ExceptionUtils.dumpStack(s, getStackTrace(), 0, -1);
final int causeDepth = ExceptionUtils.dumpCause(s, "Caused", getCause(), 1);
if( null != interruptSource ) {
ExceptionUtils.dumpCause(s, "InterruptSource", interruptSource, causeDepth);
}
}
}
|
