Mercurial > hg > truffle

comparison truffle/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/NodeFactory.java @ 21951:9c8c0937da41

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Moving all sources into truffle subdirectory
author Jaroslav Tulach <jaroslav.tulach@oracle.com>
date Wed, 17 Jun 2015 10:58:08 +0200
parents graal/com.oracle.truffle.api.dsl/src/com/oracle/truffle/api/dsl/NodeFactory.java@64dcb92ee75a
children dc83cc1f94f2
comparison
equal deleted inserted replaced
21950:2a5011c7e641 21951:9c8c0937da41
1 /*
2 * Copyright (c) 2012, 2012, 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.dsl;
26
27 import java.util.*;
28
29 import com.oracle.truffle.api.nodes.*;
30
31 /**
32 * Enables the dynamic creation of generated nodes. It provides an convenient way to instantiate
33 * generated node classes without using reflection.
34 */
35 public interface NodeFactory<T> {
36
37 /**
38 * Instantiates the node using the arguments array. The arguments length and types must suffice
39 * one of the returned signatures in {@link #getNodeSignatures()}. If the arguments array does
40 * not suffice one of the node signatures an {@link IllegalArgumentException} is thrown.
41 *
42 * @param arguments the argument values
43 * @return the instantiated node
44 * @throws IllegalArgumentException
45 */
46 T createNode(Object... arguments);
47
48 /**
49 * Returns the node class that will get created by {@link #createNode(Object...)}. The node
50 * class does not match exactly to the instantiated object but they are guaranteed to be
51 * assignable.
52 */
53 Class<T> getNodeClass();
54
55 /**
56 * Returns a list of signatures that can be used to invoke {@link #createNode(Object...)}.
57 */
58 List<List<Class<?>>> getNodeSignatures();
59
60 /**
61 * Returns a list of children that will be executed by the created node. This is useful for base
62 * nodes that can execute a variable amount of nodes.
63 */
64 List<Class<? extends Node>> getExecutionSignature();
65
66 }