cpg-core/de.fraunhofer.aisec.cpg.graph.edges.collections/EdgeList

EdgeList

abstract class EdgeList<NodeType : Node, EdgeType : Edge<NodeType>>(var thisRef: Node, var init: (start: Node, end: NodeType) -> EdgeType, var outgoing: Boolean = true, var onAdd: (EdgeType) -> Unit? = null, var onRemove: (EdgeType) -> Unit? = null) : ArrayList<EdgeType> , EdgeCollection<NodeType, EdgeType>

This class extends a list of edges. This allows us to use lists of edges more conveniently.

Inheritors

Constructors

EdgeList

constructor(thisRef: Node, init: (start: Node, end: NodeType) -> EdgeType, outgoing: Boolean = true, onAdd: (EdgeType) -> Unit? = null, onRemove: (EdgeType) -> Unit? = null)

Properties

commonType

val Collection<Type>.commonType: Type?

This computed property returns the common type in a Collection of Type objects. For example, if two types A and B both derive from the interface C`` then C` would be returned.

init

open override var init: (start: Node, end: NodeType) -> EdgeType

onAdd

open override var onAdd: (EdgeType) -> Unit?

onRemove

open override var onRemove: (EdgeType) -> Unit?

outgoing

open override var outgoing: Boolean

size

open override val size: Int

thisRef

open override var thisRef: Node

Functions

add

open fun add(target: NodeType, init: (Node, NodeType) -> EdgeType = this.init, builder: EdgeType.() -> Unit? = null): Boolean

Creates a new edge with the target node and an optional builder to include edge properties. If outgoing is true, the edge is created from thisRef ->target, otherwise from target to thisRef.

open override fun add(element: EdgeType): Boolean

open override fun add(index: Int, element: EdgeType)

fun add(index: Int, target: NodeType)

This function creates a new edge (of EdgeType) to/from the specified node target (depending on outgoing) and adds it to the specified index in the list.

add

fun <EdgeType : Edge<Node>> MutableList<Node>.add(target: Node, builder: EdgeType.() -> Unit): Boolean

addAll

open fun addAll(targets: Collection<NodeType>, builder: EdgeType.() -> Unit? = null): Boolean

open override fun addAll(elements: Collection<EdgeType>): Boolean

open override fun addAll(index: Int, elements: Collection<EdgeType>): Boolean

apply

fun TypeOperations.apply(root: Type): Type

Wraps the given Type into a chain of PointerTypes and ReferenceTypes, given the operations in TypeOperations.

byNameOrNull

fun <T : Node> Collection<T>?.byNameOrNull(lookup: String, modifier: SearchModifier): T?

This function returns the first node that matches the name on the supplied list of nodes.

clear

open override fun clear()

clone

open override fun clone(): Any

contains

open fun contains(target: NodeType): Boolean

open operator override fun contains(element: EdgeType): Boolean

containsAll

open override fun containsAll(elements: Collection<EdgeType>): Boolean

createEdge

open fun <NodeType : Node, PropertyEdgeType : Edge<NodeType>> createEdge(target: NodeType, init: (Node, NodeType) -> PropertyEdgeType, outgoing: Boolean = true, builder: PropertyEdgeType.() -> Unit? = null): PropertyEdgeType

ensureCapacity

open fun ensureCapacity(p0: Int)

equals

open operator override fun equals(other: Any?): Boolean

forEach

open override fun forEach(p0: Consumer<in EdgeType>)

get

open operator override fun get(index: Int): EdgeType

get

operator fun <T : Node> Collection<T>?.get(predicate: (T) -> Boolean, modifier: SearchModifier = SearchModifier.NONE): T?

A shortcut to call firstOrNull using the [] syntax.

operator fun <T : Node> Collection<T>?.get(lookup: String, modifier: SearchModifier = SearchModifier.NONE): T?

A shortcut to call byNameOrNull using the [] syntax.

handleOnAdd

open fun handleOnAdd(edge: EdgeType)

This function will be executed after the edge was added to the container. This can be used to propagate the edge to other properties or register additional handlers, e.g. a TypeObserver.

handleOnRemove