Mercurial > hg > graal-jvmci-8

comparison graal/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/BaseLocation.java @ 18407:f439fdb137a3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Truffle: initial commit of object API
author Andreas Woess <andreas.woess@jku.at>
date Tue, 18 Nov 2014 16:18:45 +0100
parents
children
comparison
equal deleted inserted replaced
18406:194041c3fdab 18407:f439fdb137a3
1 /*
2 * Copyright (c) 2013, 2014, 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 package com.oracle.truffle.api.object;
26
27 public interface BaseLocation {
28 /**
29 * Get object value as object at this location in store.
30 *
31 * @param shape the current shape of the object, which must contain this location
32 */
33 Object get(DynamicObject store, Shape shape);
34
35 /**
36 * Get object value as object at this location in store. For internal use only and subject to
37 * change, use {@link #get(DynamicObject, Shape)} instead.
38 *
39 * @param condition the result of a shape check or {@code false}
40 * @see #get(DynamicObject, Shape)
41 */
42 Object get(DynamicObject store, boolean condition);
43
44 /**
45 * Set object value at this location in store.
46 *
47 * @throws IncompatibleLocationException for storage type invalidations
48 * @throws FinalLocationException for effectively final fields
49 */
50 void set(DynamicObject store, Object value) throws IncompatibleLocationException, FinalLocationException;
51
52 /**
53 * Set object value at this location in store.
54 *
55 * @param shape the current shape of the storage object
56 * @throws IncompatibleLocationException for storage type invalidations
57 * @throws FinalLocationException for effectively final fields
58 */
59 void set(DynamicObject store, Object value, Shape shape) throws IncompatibleLocationException, FinalLocationException;
60
61 /**
62 * Set object value at this location in store and update shape.
63 *
64 * @param oldShape the shape before the transition
65 * @param newShape new shape after the transition
66 * @throws IncompatibleLocationException if value is of non-assignable type
67 */
68 void set(DynamicObject store, Object value, Shape oldShape, Shape newShape) throws IncompatibleLocationException;
69 }