GlueGen Runtime 2.3.2 · com.jogamp.gluegen.cgram.types.FunctionSymbol

Modifier and Type	Field and Description
private final ASTLocusTag	astLocus
private final FunctionType	type

Access	Constructor and Description
public	FunctionSymbol(final String name, final FunctionType type)
public	FunctionSymbol(final String name, final FunctionType type, final ASTLocusTag locus)
private	FunctionSymbol(final FunctionSymbol o) Warning Shallow'ish copy, only aliased names are re-created.

Method Summary

Modifier and Type	Method and Description
public void	addArgument(final Type argumentType, final String argumentName) Add an argument's name and type.
public static FunctionSymbol	cloneWithDeepAliases(final FunctionSymbol o) Shallow'ish copy, only aliased names are re-created.
public static boolean	containsExactly(final List<FunctionSymbol> l, final FunctionSymbol s)
public boolean	equals(final Object the reference object with which to compare. arg) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public final boolean	equalSemantics(final TypeComparator.SemanticEqualityOp arg) Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics. Semantic equality test for Types exclusive its given `name`.
public static int	exactIndexOf(final List<FunctionSymbol> l, final FunctionSymbol s)
public boolean	exactlyEqual(final Object arg) Compares the function type as well, since `equals(Object)` and `hashCode()` won't.
public String	getArgumentName(final int i) Returns the name of the ith argument.
public Type	getArgumentType(final int i) Returns the type of the ith argument.
public ASTLocusTag	getASTLocusTag() Implements com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag. Returns this instance's `ASTLocusTag`, if available, otherwise returns `null`.
public int	getNumArguments()
public Type	getReturnType() Returns the return type of this function.
public FunctionType	getType() Returns the type of this function.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public int	hashCodeSemantics() Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics. Semantic hashcode for Types exclusive its given `name`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toString(final boolean emitNativeTag) Helper routine for emitting native javadoc tags

Inherited from com.jogamp.gluegen.cgram.types.AliasedSymbol.AliasedSymbolImpl:: addAliasedName getAliasedNames getAliasedString getName getOrigName hasAliases rename

astLocus	back to summary
private final ASTLocusTag astLocus

type	back to summary
private final FunctionType type

FunctionSymbol	back to summary
public FunctionSymbol(final String name, final FunctionType type)

FunctionSymbol	back to summary
public FunctionSymbol(final String name, final FunctionType type, final ASTLocusTag locus)

FunctionSymbol	back to summary
private FunctionSymbol(final FunctionSymbol o) Warning Shallow'ish copy, only aliased names are re-created.

Method Detail

addArgument	back to summary
public void addArgument(final Type argumentType, final String argumentName) Add an argument's name and type. Use null for unknown argument names.

cloneWithDeepAliases	back to summary
public static FunctionSymbol cloneWithDeepAliases(final FunctionSymbol o) Shallow'ish copy, only aliased names are re-created.

containsExactly	back to summary
public static boolean containsExactly(final List<FunctionSymbol> l, final FunctionSymbol s)

equals back to summary

equals	back to summary
public boolean equals(final Object arg) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters arg:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object arg)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

arg:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

equalSemantics back to summary

equalSemantics	back to summary
public final boolean equalSemantics(final TypeComparator.SemanticEqualityOp arg) Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics. Doc from com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics. Semantic equality test for Types exclusive its given `name`. Annotations @Override

public final boolean equalSemantics(final TypeComparator.SemanticEqualityOp arg)

Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics.

Doc from com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.equalSemantics.

Semantic equality test for Types exclusive its given name.

Annotations

@Override

exactIndexOf	back to summary
public static int exactIndexOf(final List<FunctionSymbol> l, final FunctionSymbol s)

exactlyEqual	back to summary
public boolean exactlyEqual(final Object arg) Compares the function type as well, since `equals(Object)` and `hashCode()` won't.

getArgumentName	back to summary
public String getArgumentName(final int i) Returns the name of the ith argument. May return null if no argument names were available during parsing.

getArgumentType	back to summary
public Type getArgumentType(final int i) Returns the type of the ith argument.

getASTLocusTag back to summary

getASTLocusTag	back to summary
public ASTLocusTag getASTLocusTag() Implements com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag. Doc from com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag. Returns this instance's `ASTLocusTag`, if available, otherwise returns `null`. Annotations @Override

public ASTLocusTag getASTLocusTag()

Implements com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag.

Doc from com.jogamp.gluegen.ASTLocusTag.ASTLocusTagProvider.getASTLocusTag.

Returns this instance's ASTLocusTag, if available, otherwise returns null.

Annotations

@Override

getNumArguments	back to summary
public int getNumArguments()

getReturnType	back to summary
public Type getReturnType() Returns the return type of this function.

getType	back to summary
public FunctionType getType() Returns the type of this function. Do not add arguments to it directly; use addArgument instead.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

hashCodeSemantics back to summary

hashCodeSemantics	back to summary
public int hashCodeSemantics() Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics. Doc from com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics. Semantic hashcode for Types exclusive its given `name`. Annotations @Override

public int hashCodeSemantics()

Implements com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics.

Doc from com.jogamp.gluegen.cgram.types.TypeComparator.SemanticEqualityOp.hashCodeSemantics.

Semantic hashcode for Types exclusive its given name.

Annotations

@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object

Annotations

@Override

toString	back to summary
public String toString(final boolean emitNativeTag) Helper routine for emitting native javadoc tags

public Class FunctionSymbol

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail