Mercurial > hg > graal-compiler
diff graal/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/BaseLocation.java @ 18407:f439fdb137a3
Truffle: initial commit of object API
author | Andreas Woess <andreas.woess@jku.at> |
---|---|
date | Tue, 18 Nov 2014 16:18:45 +0100 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/graal/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/BaseLocation.java Tue Nov 18 16:18:45 2014 +0100 @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ +package com.oracle.truffle.api.object; + +public interface BaseLocation { + /** + * Get object value as object at this location in store. + * + * @param shape the current shape of the object, which must contain this location + */ + Object get(DynamicObject store, Shape shape); + + /** + * Get object value as object at this location in store. For internal use only and subject to + * change, use {@link #get(DynamicObject, Shape)} instead. + * + * @param condition the result of a shape check or {@code false} + * @see #get(DynamicObject, Shape) + */ + Object get(DynamicObject store, boolean condition); + + /** + * Set object value at this location in store. + * + * @throws IncompatibleLocationException for storage type invalidations + * @throws FinalLocationException for effectively final fields + */ + void set(DynamicObject store, Object value) throws IncompatibleLocationException, FinalLocationException; + + /** + * Set object value at this location in store. + * + * @param shape the current shape of the storage object + * @throws IncompatibleLocationException for storage type invalidations + * @throws FinalLocationException for effectively final fields + */ + void set(DynamicObject store, Object value, Shape shape) throws IncompatibleLocationException, FinalLocationException; + + /** + * Set object value at this location in store and update shape. + * + * @param oldShape the shape before the transition + * @param newShape new shape after the transition + * @throws IncompatibleLocationException if value is of non-assignable type + */ + void set(DynamicObject store, Object value, Shape oldShape, Shape newShape) throws IncompatibleLocationException; +}