author | rfield |
Wed, 08 Feb 2017 10:43:16 -0800 | |
changeset 43758 | 868af3718a21 |
parent 41514 | a75c2b869d8d |
child 43770 | a321bed02000 |
permissions | -rw-r--r-- |
33362 | 1 |
/* |
2 |
* Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved. |
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
|
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
7 |
* published by the Free Software Foundation. Oracle designates this |
|
8 |
* particular file as subject to the "Classpath" exception as provided |
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
|
10 |
* |
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
24 |
*/ |
|
25 |
||
26 |
package jdk.jshell; |
|
27 |
||
28 |
import jdk.jshell.Snippet.Status; |
|
29 |
||
30 |
/** |
|
31 |
* A description of a change to a Snippet. These are generated by direct changes |
|
32 |
* to state with {@link JShell#eval(java.lang.String) JShell.eval(String)} or |
|
41514
a75c2b869d8d
8167128: JShell: /drop of statement gives confusing output
rfield
parents:
38908
diff
changeset
|
33 |
* {@link JShell#drop(jdk.jshell.Snippet) JShell.drop(Snippet)}, |
33362 | 34 |
* or indirectly by these same methods as |
35 |
* dependencies change or Snippets are overwritten. For direct changes, the |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
36 |
* {@link SnippetEvent#causeSnippet()} is {@code null}. |
33362 | 37 |
* <p> |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
38 |
* {@code SnippetEvent} is immutable: an access to |
33362 | 39 |
* any of its methods will always return the same result. |
40 |
* and thus is thread-safe. |
|
41 |
* @author Robert Field |
|
42 |
*/ |
|
43 |
public class SnippetEvent { |
|
44 |
||
45 |
SnippetEvent(Snippet snippet, Status previousStatus, Status status, |
|
46 |
boolean isSignatureChange, Snippet causeSnippet, |
|
37751
77e7bb904a13
8139837: JShell API: make a common JShellException
rfield
parents:
33362
diff
changeset
|
47 |
String value, JShellException exception) { |
33362 | 48 |
this.snippet = snippet; |
49 |
this.previousStatus = previousStatus; |
|
50 |
this.status = status; |
|
51 |
this.isSignatureChange = isSignatureChange; |
|
52 |
this.causeSnippet = causeSnippet; |
|
53 |
this.value = value; |
|
54 |
this.exception = exception; |
|
55 |
} |
|
56 |
||
57 |
private final Snippet snippet; |
|
58 |
private final Status previousStatus; |
|
59 |
private final Status status; |
|
60 |
private final boolean isSignatureChange; |
|
61 |
private final Snippet causeSnippet; |
|
62 |
private final String value; |
|
37751
77e7bb904a13
8139837: JShell API: make a common JShellException
rfield
parents:
33362
diff
changeset
|
63 |
private final JShellException exception; |
33362 | 64 |
|
65 |
/** |
|
66 |
* The Snippet which has changed |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
67 |
* @return the return the Snippet whose {@code Status} has changed. |
33362 | 68 |
*/ |
69 |
public Snippet snippet() { |
|
70 |
return snippet; |
|
71 |
} |
|
72 |
||
73 |
/** |
|
74 |
* The status before the transition. If this event describes a Snippet |
|
75 |
* creation return {@link Snippet.Status#NONEXISTENT NONEXISTENT}. |
|
76 |
* @return the previousStatus |
|
77 |
*/ |
|
78 |
public Status previousStatus() { |
|
79 |
return previousStatus; |
|
80 |
} |
|
81 |
||
82 |
/** |
|
83 |
* The after status. Note: this may be the same as the previous status (not |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
84 |
* all changes cause a {@code Status} change. |
33362 | 85 |
* @return the status |
86 |
*/ |
|
87 |
public Status status() { |
|
88 |
return status; |
|
89 |
} |
|
90 |
||
91 |
/** |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
92 |
* Indicates whether the signature has changed. Coming in or out of |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
93 |
* {@linkplain Status#isDefined() definition} is always a signature change. |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
94 |
* An overwritten Snippet |
33362 | 95 |
* {@link jdk.jshell.Snippet.Status#OVERWRITTEN (status == OVERWRITTEN)} |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
96 |
* is always {@code false} as responsibility for the |
33362 | 97 |
* definition has passed to the overwriting definition. |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
98 |
* |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
99 |
* @return {@code true} if the signature changed; otherwise {@code false} |
33362 | 100 |
*/ |
101 |
public boolean isSignatureChange() { |
|
102 |
return isSignatureChange; |
|
103 |
} |
|
104 |
||
105 |
/** |
|
106 |
* Either the snippet whose change caused this update or |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
107 |
* {@code null}. This returns {@code null} if this change is the |
33362 | 108 |
* creation of a new Snippet via |
109 |
* {@link jdk.jshell.JShell#eval(java.lang.String) eval} or it is the |
|
110 |
* explicit drop of a Snippet with |
|
41514
a75c2b869d8d
8167128: JShell: /drop of statement gives confusing output
rfield
parents:
38908
diff
changeset
|
111 |
* {@link jdk.jshell.JShell#drop(jdk.jshell.Snippet) drop}. |
33362 | 112 |
* |
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
113 |
* @return the Snippet which caused this change or {@code null} if |
33362 | 114 |
* directly caused by an API action. |
115 |
*/ |
|
116 |
public Snippet causeSnippet() { |
|
117 |
return causeSnippet; |
|
118 |
} |
|
119 |
||
120 |
/** |
|
121 |
* An instance of {@link jdk.jshell.UnresolvedReferenceException}, if an unresolved reference was |
|
122 |
* encountered, or an instance of {@link jdk.jshell.EvalException} if an exception was thrown |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
123 |
* during execution, otherwise {@code null}. |
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
124 |
* @return the exception or {@code null}. |
33362 | 125 |
*/ |
37751
77e7bb904a13
8139837: JShell API: make a common JShellException
rfield
parents:
33362
diff
changeset
|
126 |
public JShellException exception() { |
33362 | 127 |
return exception; |
128 |
} |
|
129 |
||
130 |
/** |
|
131 |
* The result value of successful run. The value is null if not executed |
|
132 |
* or an exception was thrown. |
|
38908
f0c186d76c8a
8139829: JShell API: No use of fields to return information from public types
rfield
parents:
37751
diff
changeset
|
133 |
* @return the value or {@code null}. |
33362 | 134 |
*/ |
135 |
public String value() { |
|
136 |
return value; |
|
137 |
} |
|
138 |
||
139 |
/** |
|
140 |
* Return a string representation of the event |
|
141 |
* @return a descriptive representation of the SnippetEvent |
|
142 |
*/ |
|
143 |
@Override |
|
144 |
public String toString() { |
|
145 |
return "SnippetEvent(snippet=" + snippet + |
|
146 |
",previousStatus=" + previousStatus + |
|
147 |
",status=" + status + |
|
148 |
",isSignatureChange=" + isSignatureChange + |
|
149 |
",causeSnippet" + causeSnippet + |
|
150 |
(value == null? "" : "value=" + value) + |
|
151 |
(exception == null? "" : "exception=" + exception) + |
|
152 |
")"; |
|
153 |
} |
|
154 |
} |