annotate truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Location.java @ 22548:6b76a24fffbd default tip

Use all variables: a, b, u,v and x, y
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Thu, 14 Jan 2016 14:20:57 +0100
parents e3aef4c65ea1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
1 /*
22182
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
2 * Copyright (c) 2013, 2015, Oracle and/or its affiliates. All rights reserved.
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
4 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
7 * published by the Free Software Foundation. Oracle designates this
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
8 * particular file as subject to the "Classpath" exception as provided
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
9 * by Oracle in the LICENSE file that accompanied this code.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
10 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
11 * This code is distributed in the hope that it will be useful, but WITHOUT
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
14 * version 2 for more details (a copy is included in the LICENSE file that
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
15 * accompanied this code).
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
16 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License version
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
18 * 2 along with this work; if not, write to the Free Software Foundation,
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
20 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
22 * or visit www.oracle.com if you need additional information or have any
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
23 * questions.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
24 */
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
25 package com.oracle.truffle.api.object;
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
26
22157
dc83cc1f94f2 Using fully qualified imports
Jaroslav Tulach <jaroslav.tulach@oracle.com>
parents: 21951
diff changeset
27 import com.oracle.truffle.api.CompilerDirectives;
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
28
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
29 /**
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
30 * Property location.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
31 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
32 * @see Shape
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
33 * @see Property
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
34 * @see DynamicObject
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
35 */
22182
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
36 public abstract class Location {
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
37 protected static IncompatibleLocationException incompatibleLocation() throws IncompatibleLocationException {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
38 CompilerDirectives.transferToInterpreterAndInvalidate();
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
39 throw new IncompatibleLocationException();
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
40 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
41
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
42 protected static FinalLocationException finalLocation() throws FinalLocationException {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
43 CompilerDirectives.transferToInterpreterAndInvalidate();
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
44 throw new FinalLocationException();
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
45 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
46
22182
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
47 /**
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
48 * Get object value as object at this location in store.
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
49 *
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
50 * @param shape the current shape of the object, which must contain this location
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
51 */
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
52 public final Object get(DynamicObject store, Shape shape) {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
53 return get(store, checkShape(store, shape));
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
54 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
55
22182
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
56 /**
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
57 * Get object value as object at this location in store. For internal use only and subject to
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
58 * change, use {@link #get(DynamicObject, Shape)} instead.
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
59 *
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
60 * @param condition the result of a shape check or {@code false}
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
61 * @see #get(DynamicObject, Shape)
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
62 */
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
63 public Object get(DynamicObject store, boolean condition) {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
64 return getInternal(store);
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
65 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
66
22182
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
67 /**
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
68 * Get object value as object at this location in store.
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
69 *
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
70 */
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
71 public final Object get(DynamicObject store) {
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
72 return get(store, false);
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
73 }
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
74
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
75 /**
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
76 * Set object value at this location in store.
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
77 *
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
78 * @param shape the current shape of the storage object
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
79 * @throws IncompatibleLocationException for storage type invalidations
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
80 * @throws FinalLocationException for effectively final fields
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
81 */
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
82 public void set(DynamicObject store, Object value, Shape shape) throws IncompatibleLocationException, FinalLocationException {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
83 setInternal(store, value);
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
84 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
85
22182
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
86 /**
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
87 * Set object value at this location in store and update shape.
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
88 *
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
89 * @param oldShape the shape before the transition
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
90 * @param newShape new shape after the transition
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
91 * @throws IncompatibleLocationException if value is of non-assignable type
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
92 */
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
93 public final void set(DynamicObject store, Object value, Shape oldShape, Shape newShape) throws IncompatibleLocationException {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
94 if (canStore(value)) {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
95 store.setShapeAndGrow(oldShape, newShape);
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
96 try {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
97 setInternal(store, value);
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
98 } catch (IncompatibleLocationException ex) {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
99 throw new IllegalStateException();
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
100 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
101 } else {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
102 throw incompatibleLocation();
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
103 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
104 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
105
22182
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
106 /**
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
107 * Set object value at this location in store.
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
108 *
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
109 * @throws IncompatibleLocationException for storage type invalidations
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
110 * @throws FinalLocationException for effectively final fields
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
111 */
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
112 public final void set(DynamicObject store, Object value) throws IncompatibleLocationException, FinalLocationException {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
113 set(store, value, null);
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
114 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
115
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
116 protected abstract Object getInternal(DynamicObject store);
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
117
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
118 /**
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
119 * Like {@link #set(DynamicObject, Object, Shape)}, but does not invalidate final locations. For
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
120 * internal use only and subject to change, use {@link DynamicObjectFactory} to create objects
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
121 * with predefined properties.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
122 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
123 * @throws IncompatibleLocationException if value is of non-assignable type
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
124 */
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
125 protected abstract void setInternal(DynamicObject store, Object value) throws IncompatibleLocationException;
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
126
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
127 /**
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
128 * Returns {@code true} if the location can be set to the value.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
129 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
130 * @param store the receiver object
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
131 * @param value the value in question
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
132 */
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
133 public boolean canSet(DynamicObject store, Object value) {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
134 return canStore(value);
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
135 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
136
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
137 /**
22199
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
138 * Returns {@code true} if the location can be set to the value.
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
139 *
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
140 * @param value the value in question
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
141 */
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
142 public boolean canSet(Object value) {
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
143 return canStore(value);
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
144 }
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
145
e3aef4c65ea1 add Location#canSet(value)
Andreas Woess <andreas.woess@oracle.com>
parents: 22193
diff changeset
146 /**
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
147 * Returns {@code true} if the location is compatible with the value.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
148 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
149 * The value may still be rejected if {@link #canSet(DynamicObject, Object)} returns false.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
150 *
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
151 * @param value the value in question
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
152 */
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
153 public boolean canStore(Object value) {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
154 return true;
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
155 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
156
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
157 /**
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
158 * Returns {@code true} if this is a final location, i.e. readonly once set.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
159 */
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
160 public boolean isFinal() {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
161 return false;
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
162 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
163
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
164 /**
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
165 * Returns {@code true} if this is an immutable constant location.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
166 */
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
167 public boolean isConstant() {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
168 return false;
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
169 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
170
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
171 /*
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
172 * Abstract to force overriding.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
173 */
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
174 @Override
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
175 public abstract int hashCode();
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
176
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
177 /*
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
178 * Abstract to force overriding.
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
179 */
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
180 @Override
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
181 public abstract boolean equals(Object obj);
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
182
22182
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
183 /**
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
184 * Equivalent to {@link Shape#check(DynamicObject)}.
21863e2a1d34 api.object: remove BaseLocation interface
Andreas Woess <andreas.woess@oracle.com>
parents: 22157
diff changeset
185 */
18407
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
186 protected static boolean checkShape(DynamicObject store, Shape shape) {
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
187 return store.getShape() == shape;
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
188 }
f439fdb137a3 Truffle: initial commit of object API
Andreas Woess <andreas.woess@jku.at>
parents:
diff changeset
189 }