Modifier and Type	Class and Description
public static class	EnumType.Enumerator

Modifier and Type	Field and Description
private ArrayList<EnumType.Enumerator>	enums
private final IntType	underlyingType

Access	Constructor and Description
public	EnumType(final String name)
public	EnumType(final String name, final SizeThunk enumSizeInBytes, final ASTLocusTag astLocus)
private	EnumType(final EnumType o, final int cvAttributes, final ASTLocusTag astLocus)

Method Summary

Modifier and Type	Method and Description
public void	addEnum(final String name, final EnumType.Enumerator newEnum)
public StringBuilder	appendEnums(final StringBuilder sb, final boolean cr)
public EnumType	asEnum() Overrides com.jogamp.gluegen.cgram.types.Type.asEnum. Casts this to an EnumType or returns null if not an EnumType.
public boolean	containsEnumerate(final String name) Does this enum type contain an enumerate with the given name?
protected boolean	equalSemanticsImpl(final Type arg) Overrides com.jogamp.gluegen.cgram.types.IntType.equalSemanticsImpl.
protected boolean	equalsImpl(final Type arg) Overrides com.jogamp.gluegen.cgram.types.IntType.equalsImpl.
public EnumType.Enumerator	getEnum(final int i) Fetch ith (0..getNumEnumerates() - 1) `Enumerator`
public EnumType.Enumerator	getEnum(final String name) Fetch the enumerate with the given name.
public int	getNumEnumerates() Number of enumerates defined in this enum.
public Type	getUnderlyingType()
protected int	hashCodeImpl() Overrides com.jogamp.gluegen.cgram.types.IntType.hashCodeImpl.
protected int	hashCodeSemanticsImpl() Overrides com.jogamp.gluegen.cgram.types.IntType.hashCodeSemanticsImpl.
pack-priv Type	newVariantImpl(final boolean true if new variant is intended to have new cvAttributes newCVVariant, final int the cvAttributes to be used cvAttributes, final ASTLocusTag the `ASTLocusTag` to be used astLocus) Overrides com.jogamp.gluegen.cgram.types.IntType.newVariantImpl. Create a new variant of this type matching the given parameter Implementation must use `Type`'s copy-ctor: `Type(Type, int, ASTLocusTag)`!
public boolean	removeEnumerate(final String name) Remove the enumerate with the given name.
public void	visit(final TypeVisitor arg) Overrides com.jogamp.gluegen.cgram.types.Type.visit. Traverse this `Type` and all of its component types; for example, the return type and argument types of a FunctionType.

Inherited from com.jogamp.gluegen.cgram.types.IntType:: asInt getCName isUnsigned setTypedefName toString

enums	back to summary
private ArrayList<EnumType.Enumerator> enums

underlyingType	back to summary
private final IntType underlyingType

Constructor Detail

EnumType	back to summary
public EnumType(final String name)

EnumType	back to summary
public EnumType(final String name, final SizeThunk enumSizeInBytes, final ASTLocusTag astLocus)

EnumType	back to summary
private EnumType(final EnumType o, final int cvAttributes, final ASTLocusTag astLocus)

Method Detail

addEnum	back to summary
public void addEnum(final String name, final EnumType.Enumerator newEnum)

appendEnums	back to summary
public StringBuilder appendEnums(final StringBuilder sb, final boolean cr)

asEnum	back to summary
public EnumType asEnum() Overrides com.jogamp.gluegen.cgram.types.Type.asEnum. Doc from com.jogamp.gluegen.cgram.types.Type.asEnum. Casts this to an EnumType or returns null if not an EnumType. Annotations @Override

asEnum

back to summary

public EnumType asEnum()

Overrides com.jogamp.gluegen.cgram.types.Type.asEnum.

Doc from com.jogamp.gluegen.cgram.types.Type.asEnum.

Casts this to an EnumType or returns null if not an EnumType.

Annotations

@Override

containsEnumerate	back to summary
public boolean containsEnumerate(final String name) Does this enum type contain an enumerate with the given name?

equalSemanticsImpl	back to summary
protected boolean equalSemanticsImpl(final Type arg) Overrides com.jogamp.gluegen.cgram.types.IntType.equalSemanticsImpl. Annotations @Override

equalSemanticsImpl

back to summary

protected boolean equalSemanticsImpl(final Type arg)

Overrides com.jogamp.gluegen.cgram.types.IntType.equalSemanticsImpl.

Annotations

@Override

equalsImpl	back to summary
protected boolean equalsImpl(final Type arg) Overrides com.jogamp.gluegen.cgram.types.IntType.equalsImpl. Annotations @Override

equalsImpl

back to summary

protected boolean equalsImpl(final Type arg)

Overrides com.jogamp.gluegen.cgram.types.IntType.equalsImpl.

Annotations

@Override

getEnum	back to summary
public EnumType.Enumerator getEnum(final int i) Fetch ith (0..getNumEnumerates() - 1) `Enumerator`

getEnum	back to summary
public EnumType.Enumerator getEnum(final String name) Fetch the enumerate with the given name.

getNumEnumerates	back to summary
public int getNumEnumerates() Number of enumerates defined in this enum.

getUnderlyingType	back to summary
public Type getUnderlyingType()

hashCodeImpl	back to summary
protected int hashCodeImpl() Overrides com.jogamp.gluegen.cgram.types.IntType.hashCodeImpl. Annotations @Override

hashCodeImpl

back to summary

protected int hashCodeImpl()

Overrides com.jogamp.gluegen.cgram.types.IntType.hashCodeImpl.

Annotations

@Override

hashCodeSemanticsImpl	back to summary
protected int hashCodeSemanticsImpl() Overrides com.jogamp.gluegen.cgram.types.IntType.hashCodeSemanticsImpl. Annotations @Override

hashCodeSemanticsImpl

back to summary

protected int hashCodeSemanticsImpl()

Overrides com.jogamp.gluegen.cgram.types.IntType.hashCodeSemanticsImpl.

Annotations

@Override

newVariantImpl back to summary

newVariantImpl	back to summary
pack-priv Type newVariantImpl(final boolean newCVVariant, final int cvAttributes, final ASTLocusTag astLocus) Overrides com.jogamp.gluegen.cgram.types.IntType.newVariantImpl. Doc from com.jogamp.gluegen.cgram.types.Type.newVariantImpl. Create a new variant of this type matching the given parameter Implementation must use `Type`'s copy-ctor: `Type(Type, int, ASTLocusTag)`! Parameters newCVVariant:boolean true if new variant is intended to have new cvAttributes cvAttributes:int the cvAttributes to be used astLocus:ASTLocusTag the `ASTLocusTag` to be used Annotations @Override

pack-priv Type newVariantImpl(final boolean newCVVariant, final int cvAttributes, final ASTLocusTag astLocus)

Overrides com.jogamp.gluegen.cgram.types.IntType.newVariantImpl.

Doc from com.jogamp.gluegen.cgram.types.Type.newVariantImpl.

Create a new variant of this type matching the given parameter

Implementation must use Type's copy-ctor: Type(Type, int, ASTLocusTag)!

Parameters

newCVVariant:boolean: true if new variant is intended to have new cvAttributes
cvAttributes:int: the cvAttributes to be used
astLocus:ASTLocusTag: the ASTLocusTag to be used

Annotations

@Override

removeEnumerate	back to summary
public boolean removeEnumerate(final String name) Remove the enumerate with the given name. Returns true if it was found and removed; false if it was not found.

visit back to summary

visit	back to summary
public void visit(final TypeVisitor arg) Overrides com.jogamp.gluegen.cgram.types.Type.visit. Doc from com.jogamp.gluegen.cgram.types.Type.visit. Traverse this `Type` and all of its component types; for example, the return type and argument types of a FunctionType. Annotations @Override

public void visit(final TypeVisitor arg)

Overrides com.jogamp.gluegen.cgram.types.Type.visit.

Doc from com.jogamp.gluegen.cgram.types.Type.visit.

Traverse this Type and all of its component types; for example, the return type and argument types of a FunctionType.

Annotations

@Override

com.jogamp.gluegen.cgram.types back to summary

public Class EnumType.Enumerator

Class Inheritance

extends Object
implements SemanticEqualityOp

java.lang.Object
com.jogamp.gluegen.cgram.types.EnumType.Enumerator

All Implemented Interfaces

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

Field Summary

Modifier and Type	Field and Description
private final String	expr
private final String	name
private final ConstantDefinition.CNumber	number

Constructor Summary

Access	Constructor and Description
public	Enumerator(final String name, final long value)
public	Enumerator(final String name, final ConstantDefinition.CNumber number)
public	Enumerator(final String name, final String value)

Method Summary

Modifier and Type	Method and Description
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 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 String	getExpr()
public String	getName()
public ConstantDefinition.CNumber	getNumber()
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 boolean	hasNumber()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

expr	back to summary
private final String expr

name	back to summary
private final String name

number	back to summary
private final ConstantDefinition.CNumber number

Constructor Detail

Enumerator	back to summary
public Enumerator(final String name, final long value)

Enumerator	back to summary
public Enumerator(final String name, final ConstantDefinition.CNumber number)

Enumerator	back to summary
public Enumerator(final String name, final String value)

Method Detail

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 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 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

getExpr	back to summary
public String getExpr()

getName	back to summary
public String getName()

getNumber	back to summary
public ConstantDefinition.CNumber getNumber()

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

hasNumber	back to summary
public boolean hasNumber()

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