Mercurial > hg > truffle
changeset 22181:4eb6f179a326
api.object: add some missing javadoc
| author | Andreas Woess <andreas.woess@oracle.com> |
|---|---|
| date | Tue, 22 Sep 2015 15:32:14 +0200 |
| parents | 5e5b38579bda |
| children | 21863e2a1d34 |
| files | truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/DynamicObjectFactory.java truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/LayoutFactory.java truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/LocationFactory.java truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/ObjectType.java truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Property.java truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/ShapeListener.java truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/package-info.java |
| diffstat | 7 files changed, 35 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/DynamicObjectFactory.java Tue Sep 22 14:56:59 2015 +0200 +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/DynamicObjectFactory.java Tue Sep 22 15:32:14 2015 +0200 @@ -24,8 +24,24 @@ */ package com.oracle.truffle.api.object; +/** + * This factory can be used to create a new {@link DynamicObject} from an initial shape, with its + * instance properties initialized to the values passed to {@link #newInstance(Object...)}. + * + * @see Shape#createFactory() + */ public interface DynamicObjectFactory { + /** + * Create a new {@link DynamicObject} and initialize instance properties with the provided + * values. Exactly as many values are required as there are instance properties. + * + * @param initialValues the values to initialize the object with, in order. + * @return a new {@link DynamicObject} initialized with the provided values. + */ DynamicObject newInstance(Object... initialValues); + /** + * @return the shape of objects created by this factory. + */ Shape getShape(); }
--- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/LayoutFactory.java Tue Sep 22 14:56:59 2015 +0200 +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/LayoutFactory.java Tue Sep 22 15:32:14 2015 +0200 @@ -24,6 +24,9 @@ */ package com.oracle.truffle.api.object; +/** + * Implementation class. + */ public interface LayoutFactory { Layout createLayout(Layout.Builder layoutBuilder);
--- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/LocationFactory.java Tue Sep 22 14:56:59 2015 +0200 +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/LocationFactory.java Tue Sep 22 15:32:14 2015 +0200 @@ -24,6 +24,11 @@ */ package com.oracle.truffle.api.object; +/** + * This interface allows to provide a custom location for a given shape and value. + * + * @see DynamicObject#define(Object, Object, int, LocationFactory) + */ public interface LocationFactory { Location createLocation(Shape shape, Object value); }
--- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/ObjectType.java Tue Sep 22 14:56:59 2015 +0200 +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/ObjectType.java Tue Sep 22 15:32:14 2015 +0200 @@ -30,6 +30,9 @@ import com.oracle.truffle.api.interop.Message; import com.oracle.truffle.api.interop.TruffleObject; +/** + * An extensible object type descriptor for {@link DynamicObject}s. + */ public class ObjectType { /** * Delegate method for {@link DynamicObject#equals(Object)}.
--- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Property.java Tue Sep 22 14:56:59 2015 +0200 +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/Property.java Tue Sep 22 15:32:14 2015 +0200 @@ -32,6 +32,9 @@ protected Property() { } + /** + * Create a new property. + */ public static Property create(Object key, Location location, int flags) { return Layout.getFactory().createProperty(key, location, flags); }
--- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/ShapeListener.java Tue Sep 22 14:56:59 2015 +0200 +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/ShapeListener.java Tue Sep 22 15:32:14 2015 +0200 @@ -24,6 +24,9 @@ */ package com.oracle.truffle.api.object; +/** + * A listener to be notified of property transitions. + */ public interface ShapeListener { /** * Called when a property is added, removed, or replaced.
--- a/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/package-info.java Tue Sep 22 14:56:59 2015 +0200 +++ b/truffle/com.oracle.truffle.api.object/src/com/oracle/truffle/api/object/package-info.java Tue Sep 22 15:32:14 2015 +0200 @@ -29,7 +29,8 @@ ) */ -/** Optimal object model. +/** + * Dynamic object storage model. */ package com.oracle.truffle.api.object;