Package de.fraunhofer.aisec.cpg.graph

Class FunctionDeclaration

java.lang.Object

de.fraunhofer.aisec.cpg.graph.Node

de.fraunhofer.aisec.cpg.graph.Declaration

de.fraunhofer.aisec.cpg.graph.ValueDeclaration

de.fraunhofer.aisec.cpg.graph.FunctionDeclaration

All Implemented Interfaces:

HasType

Direct Known Subclasses:

MethodDeclaration

public class FunctionDeclaration
extends ValueDeclaration

Represents the declaration or definition of a function.

Nested Class Summary

Nested classes/interfaces inherited from interface de.fraunhofer.aisec.cpg.graph.HasType

HasType.TypeListener

Field Summary

Fields

Modifier and Type	Field	Description
protected Statement	body	The function body.
protected java.util.List<ParamVariableDeclaration>	parameters	The list of function parameters.
protected java.util.List<Type>	throwsTypes

Fields inherited from class de.fraunhofer.aisec.cpg.graph.ValueDeclaration

possibleSubTypes, type

Fields inherited from class de.fraunhofer.aisec.cpg.graph.Node

code, comment, dummy, EMPTY_NAME, file, implicit, log, name, nextCFG, nextDFG, nextEOG, prevDFG, prevEOG, region, TO_STRING_STYLE

Constructor Summary

Constructors

Constructor	Description
FunctionDeclaration()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
Statement	getBody()
<T> @Nullable T	getBodyStatementAs(int i, java.lang.Class<T> clazz)
java.util.List<FunctionDeclaration>	getOverriddenBy()
java.util.List<FunctionDeclaration>	getOverrides()
java.util.List<ParamVariableDeclaration>	getParameters()
java.lang.String	getSignature()
java.util.List<Type>	getThrowsTypes()
java.util.Optional<VariableDeclaration>	getVariableDeclarationByName(java.lang.String name)	Looks for a variable declaration by the given name.
boolean	hasBody()
int	hashCode()
boolean	hasSignature(java.util.List<Type> targetSignature)
boolean	isOverrideCandidate(FunctionDeclaration other)
void	setBody(Statement body)
void	setParameters(java.util.List<ParamVariableDeclaration> parameters)
void	setThrowsTypes(java.util.List<Type> throwsTypes)
java.lang.String	toString()

Methods inherited from class de.fraunhofer.aisec.cpg.graph.ValueDeclaration

getPossibleSubTypes, getType, getTypeListeners, refreshType, registerTypeListener, resetTypes, setPossibleSubTypes, setType, unregisterTypeListener

Methods inherited from class de.fraunhofer.aisec.cpg.graph.Node

addNextDFG, addPrevDFG, disconnectFromGraph, getArgumentIndex, getCode, getFile, getId, getName, getNextCFG, getNextDFG, getNextEOG, getPrevDFG, getPrevEOG, getRegion, isDummy, isImplicit, removeNextDFG, removePrevDFG, setArgumentIndex, setCode, setComment, setDummy, setFile, setImplicit, setName, setNextDFG, setNextEOG, setPrevDFG, setPrevEOG, setRegion

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.fraunhofer.aisec.cpg.graph.HasType

setPossibleSubTypes, setType

Field Detail

body

protected Statement body

The function body. Usually a CompoundStatement.

parameters

protected java.util.List<ParamVariableDeclaration> parameters

The list of function parameters.

throwsTypes

protected java.util.List<Type> throwsTypes

Constructor Detail

FunctionDeclaration

public FunctionDeclaration()

Method Detail

hasBody

public boolean hasBody()

getSignature

public java.lang.String getSignature()

hasSignature

public boolean hasSignature(java.util.List<Type> targetSignature)

isOverrideCandidate

public boolean isOverrideCandidate(FunctionDeclaration other)

getOverriddenBy

public java.util.List<FunctionDeclaration> getOverriddenBy()

getOverrides

public java.util.List<FunctionDeclaration> getOverrides()

getThrowsTypes

public java.util.List<Type> getThrowsTypes()

setThrowsTypes

public void setThrowsTypes(java.util.List<Type> throwsTypes)

getBody

public Statement getBody()

getBodyStatementAs

public <T> @Nullable T getBodyStatementAs(int i,
                                          java.lang.Class<T> clazz)

setBody

public void setBody(Statement body)

getParameters

public java.util.List<ParamVariableDeclaration> getParameters()

setParameters

public void setParameters(java.util.List<ParamVariableDeclaration> parameters)

getVariableDeclarationByName

public java.util.Optional<VariableDeclaration> getVariableDeclarationByName(java.lang.String name)

Looks for a variable declaration by the given name.

Parameters:

name - the name of the variable

Returns:

an optional value containing the variable declaration if found

toString

public java.lang.String toString()

Overrides:

toString in class ValueDeclaration

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ValueDeclaration

hashCode

public int hashCode()

Overrides:

hashCode in class ValueDeclaration