org.graalvm.compiler.truffle.common

Class VoidGraphStructure

java.lang.Object

org.graalvm.compiler.truffle.common.VoidGraphStructure

All Implemented Interfaces:

GraphStructure<Void,Void,Void,Void>

public final class VoidGraphStructure
extends Object
implements GraphStructure<Void,Void,Void,Void>

Field Summary

Fields

Modifier and Type	Field and Description
static GraphStructure<Void,Void,Void,Void>	INSTANCE

Method Summary

Modifier and Type	Method and Description
Void	classForNode(Void node) Finds a node class for node.
boolean	edgeDirect(Void port, int index) Checks whether an edge is direct.
String	edgeName(Void port, int index) The name of an edge.
Collection<? extends Void>	edgeNodes(Void graph, Void node, Void port, int index) Nodes where the edges for a port lead to/from.
Object	edgeType(Void port, int index) Type of an edge.
Void	graph(Void currentGraph, Object obj) Casts obj to graph, if possible.
String	nameTemplate(Void nodeClass) The template used to build the name of nodes of this class.
Void	node(Object obj) Finds a node for obj, if possible.
Void	nodeClass(Object obj) Finds a node class for obj, if possible.
Object	nodeClassType(Void nodeClass) Java class for a node class.
boolean	nodeHasPredecessor(Void node) Checks if there is a predecessor for a node.
int	nodeId(Void node) Id of node.
void	nodeProperties(Void graph, Void node, Map<String,? super Object> properties) Collects node properties.
Iterable<? extends Void>	nodes(Void graph) Nodes of a graph.
int	nodesCount(Void graph) Number of nodes in a graph.
Void	portInputs(Void nodeClass) Input ports of a node class.
Void	portOutputs(Void nodeClass) Output ports of a node class.
int	portSize(Void port) The number of edges in a port.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final GraphStructure<Void,Void,Void,Void> INSTANCE

Method Detail

graph

public Void graph(Void currentGraph,
                  Object obj)

Description copied from interface: GraphStructure

Casts obj to graph, if possible. If the given object obj can be seen as a graph or sub-graph of a graph, then return the properly typed instance. Otherwise return null

Specified by:

graph in interface GraphStructure<Void,Void,Void,Void>

Parameters:

currentGraph - the currently processed graph

obj - an object to check and view as a graph

Returns:

appropriate graph object or null if the object doesn't represent a graph

nodes

public Iterable<? extends Void> nodes(Void graph)

Description copied from interface: GraphStructure

Nodes of a graph. Each graph is composed from a fixed set of nodes. This method returns an iterable which provides access to all of them - the number of nodes provided by the iterable must match the number returned by GraphStructure.nodesCount(java.lang.Object) method.

Specified by:

nodes in interface GraphStructure<Void,Void,Void,Void>

Parameters:

graph - the graph to query for nodes

Returns:

iterable with all the graph's nodes

See Also:

GraphStructure.nodesCount(java.lang.Object)

nodesCount

public int nodesCount(Void graph)

Description copied from interface: GraphStructure

Number of nodes in a graph. The number must match the content returned by GraphStructure.nodes(java.lang.Object) method.

Specified by:

nodesCount in interface GraphStructure<Void,Void,Void,Void>

Parameters:

graph - the graph to query

Returns:

the number of nodes that will be returned by GraphStructure.nodes(java.lang.Object)

nodeId

public int nodeId(Void node)

Description copied from interface: GraphStructure

Id of node. Each node in the graph is uniquely identified by an integer value. If two nodes have the same id, then they shall be == to each other.

Specified by:

nodeId in interface GraphStructure<Void,Void,Void,Void>

Parameters:

node - the node to query for an id

Returns:

the id of the node

nodeHasPredecessor

public boolean nodeHasPredecessor(Void node)

Description copied from interface: GraphStructure

Checks if there is a predecessor for a node.

Specified by:

nodeHasPredecessor in interface GraphStructure<Void,Void,Void,Void>

Parameters:

node - the node to check

Returns:

true if it has a predecessor, false otherwise

nodeProperties

public void nodeProperties(Void graph,
                           Void node,
                           Map<String,? super Object> properties)

Description copied from interface: GraphStructure

Collects node properties. Each node can be associated with additional properties identified by their name. This method shall copy them into the provided map.

Specified by:

nodeProperties in interface GraphStructure<Void,Void,Void,Void>

Parameters:

graph - the current graph

node - the node to collect properties for

properties - the map to put the properties to

node

public Void node(Object obj)

Description copied from interface: GraphStructure

Finds a node for obj, if possible. If the given object obj can be seen as an instance of node return the properly typed instance of the node class. Otherwise return null.

Specified by:

node in interface GraphStructure<Void,Void,Void,Void>

Parameters:

obj - an object to find node for

Returns:

appropriate graph object or null if the object doesn't represent a node

nodeClass

public Void nodeClass(Object obj)

Description copied from interface: GraphStructure

Finds a node class for obj, if possible. If the given object obj can be seen as an instance of node class return the properly typed instance of the node class. Otherwise return null.

Specified by:

nodeClass in interface GraphStructure<Void,Void,Void,Void>

Parameters:

obj - an object to find node class for

Returns:

appropriate graph object or null if the object doesn't represent a node class

classForNode

public Void classForNode(Void node)

Description copied from interface: GraphStructure

Finds a node class for node.

Specified by:

classForNode in interface GraphStructure<Void,Void,Void,Void>

Parameters:

node - an instance of node in this graph

Returns:

the node's node class, never null

nameTemplate

public String nameTemplate(Void nodeClass)

Description copied from interface: GraphStructure

The template used to build the name of nodes of this class. The template may use references to inputs ({i#inputName}) and its properties ({p#propertyName}).

Specified by:

nameTemplate in interface GraphStructure<Void,Void,Void,Void>

Parameters:

nodeClass - the node class to find name template for

Returns:

the string representing the template

nodeClassType

public Object nodeClassType(Void nodeClass)

Description copied from interface: GraphStructure

Java class for a node class.

Specified by:

nodeClassType in interface GraphStructure<Void,Void,Void,Void>

Parameters:

nodeClass - the node class

Returns:

the Class or other type representation of the node class

portInputs

public Void portInputs(Void nodeClass)

Description copied from interface: GraphStructure

Input ports of a node class. Each node class has a fixed set of ports where individual edges can attach to.

Specified by:

portInputs in interface GraphStructure<Void,Void,Void,Void>

Parameters:

nodeClass - the node class

Returns:

input ports for the node class

portOutputs

public Void portOutputs(Void nodeClass)

Description copied from interface: GraphStructure

Output ports of a node class. Each node class has a fixed set of ports from where individual edges can point to other nodes.

Specified by:

portOutputs in interface GraphStructure<Void,Void,Void,Void>

Parameters:

nodeClass - the node class

Returns:

output ports for the node class

portSize

public int portSize(Void port)

Description copied from interface: GraphStructure

The number of edges in a port. The protocol will then call methods GraphStructure.edgeDirect(java.lang.Object, int), GraphStructure.edgeName(java.lang.Object, int), GraphStructure.edgeType(java.lang.Object, int) and GraphStructure.edgeNodes(java.lang.Object, java.lang.Object, java.lang.Object, int) for indexes from 0 to portSize - 1

Specified by:

portSize in interface GraphStructure<Void,Void,Void,Void>

Parameters:

port - the port

Returns:

number of edges in this port

edgeDirect

public boolean edgeDirect(Void port,
                          int index)

Description copied from interface: GraphStructure

Checks whether an edge is direct. Direct edge shall have exactly one node - it is an error to return more than one for such an edge from the method.

Specified by:

edgeDirect in interface GraphStructure<Void,Void,Void,Void>

Parameters:

port - the port

index - index from 0 to GraphStructure.portSize(java.lang.Object) minus 1

Returns:

true if only one node can be returned from GraphStructure.edgeNodes(java.lang.Object, java.lang.Object, java.lang.Object, int) method

edgeName

public String edgeName(Void port,
                       int index)

Description copied from interface: GraphStructure

The name of an edge.

Specified by:

edgeName in interface GraphStructure<Void,Void,Void,Void>

Parameters:

port - the port

index - index from 0 to GraphStructure.portSize(java.lang.Object) minus 1

Returns:

the name of the edge

edgeType

public Object edgeType(Void port,
                       int index)

Description copied from interface: GraphStructure

Type of an edge. The type must be a graph enum - e.g. either real instance of Enum subclass, or something that the GraphOutput.Builder can recognize as enum.

Specified by:

edgeType in interface GraphStructure<Void,Void,Void,Void>

index - index from 0 to GraphStructure.portSize(java.lang.Object) minus 1

Returns:

any Enum representing type of the edge

edgeNodes

public Collection<? extends Void> edgeNodes(Void graph,
                                            Void node,
                                            Void port,
                                            int index)

Description copied from interface: GraphStructure

Nodes where the edges for a port lead to/from. This method is called for both direct/non-direct edges. In case of a direct edge the returned collection must have exactly one element.

Specified by:

edgeNodes in interface GraphStructure<Void,Void,Void,Void>

Parameters:

graph - the graph

node - the node in the graph

port - port of the node class

index - index from 0 to GraphStructure.portSize(java.lang.Object) minus 1

Returns:

null if there are no edges associated with given port or collection of nodes where to/from the edges lead to