com.oracle.truffle.api.object.DynamicObjectFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation

Truffle is a multi-language framework for executing dynamic languages that achieves high performance when combined with Graal.

There is a newer version: 1.0.0-rc7

Show newest version

/*
 * Copyright (c) 2014, 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;

/**
 * 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()
 * @since 0.8 or earlier
 */
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.
     * @since 0.8 or earlier
     */
    DynamicObject newInstance(Object... initialValues);

    /**
     * @return the shape of objects created by this factory.
     * @since 0.8 or earlier
     */
    Shape getShape();
}