Nested and Inner Type Summary

Modifier and Type	Class and Description
private static enum	JavaType.C_PTR

Field Summary

Modifier and Type	Field and Description
private final Class<?>	clazz
private final Type	elementType
private static JavaType	nioBufferType
private static JavaType	nioByteBufferArrayType
private static JavaType	nioByteBufferType
private static JavaType	nioDoubleBufferType
private static JavaType	nioFloatBufferType
private static JavaType	nioIntBufferType
private static JavaType	nioLongBufferType
private static JavaType	nioPointerBufferType
private static JavaType	nioShortBufferType
private final boolean	opaqued
private final JavaType.C_PTR	primitivePointerType
private final String	structName

Constructor Summary

Access	Constructor and Description
private	JavaType(final Class<?> clazz, final boolean opaqued) Constructs a representation for a type corresponding to the given Class argument.
private	JavaType(final String structName) Constructs a type representing a named C struct.
private	JavaType(final JavaType.C_PTR primitivePointerType) Constructs a type representing a pointer to a C primitive (integer, floating-point, or void pointer) type.
private	JavaType(final Type elementType) Constructs a type representing an array of C pointers.
private	JavaType(final JavaType.C_PTR primitivePointerType, final Class<?> clazz, final String name, final Type elementType) clone only

Method Summary

Modifier and Type	Method and Description
private void	append(final StringBuilder sb, final String val, final boolean prepComma)
private String	arrayDescriptor(Class<?> clazz)
private String	arrayName(Class<?> clazz)
public Object	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public static JavaType	createForCArray(final Type elementType) Creates a JavaType corresponding to an array of the given element type.
public static JavaType	createForCCharPointer()
public static JavaType	createForCDoublePointer()
public static JavaType	createForCFloatPointer()
public static JavaType	createForCInt32Pointer()
public static JavaType	createForCInt64Pointer()
public static JavaType	createForClass(final Class<?> clazz) Creates a JavaType corresponding to the given Java type.
public static JavaType	createForCShortPointer()
public static JavaType	createForCStruct(final String name) Creates a JavaType corresponding to the specified C CompoundType name; for example, if "Foo" is supplied, then this JavaType represents a "Foo *" by way of a StructAccessor.
public static JavaType	createForCVoidPointer()
public static JavaType	createForJNIEnv()
public static JavaType	createForOpaqueClass(final Class<?> clazz) Creates a JavaType corresponding to the given opaque Java type.
private String	descriptor(final Class<?> clazz)
private String	descriptor(final String referenceTypeName)
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 static JavaType	forNIOBufferClass()
public static JavaType	forNIOByteBufferArrayClass()
public static JavaType	forNIOByteBufferClass()
public static JavaType	forNIODoubleBufferClass()
public static JavaType	forNIOFloatBufferClass()
public static JavaType	forNIOIntBufferClass()
public static JavaType	forNIOLongBufferClass()
public static JavaType	forNIOPointerBufferClass()
public static JavaType	forNIOShortBufferClass()
public String	getDebugString()
public String	getDescriptor() Returns the descriptor (internal type signature) corresponding to this type.
public Type	getElementCType()
public JavaType	getElementType()
public Class<?>	getJavaClass() Returns the Java Class corresponding to this type.
public String	getName() Returns the Java type name corresponding to this type.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public boolean	isArray()
public boolean	isArrayOfCompoundTypeWrappers()
public boolean	isByte()
public boolean	isByteArray()
public boolean	isCCharPointerType()
public boolean	isCDoublePointerType()
public boolean	isCFloatPointerType()
public boolean	isCInt32PointerType()
public boolean	isCInt64PointerType()
public boolean	isCompoundTypeWrapper()
public boolean	isCPrimitivePointerType()
public boolean	isCShortPointerType()
public boolean	isCVoidPointerType()
public boolean	isDouble()
public boolean	isDoubleArray()
public boolean	isFloat()
public boolean	isFloatArray()
public boolean	isInt()
public boolean	isIntArray()
public boolean	isJNIEnv()
public boolean	isLong()
public boolean	isLongArray()
public boolean	isNIOBuffer()
public boolean	isNIOBufferArray()
public boolean	isNIOByteBuffer()
public boolean	isNIOByteBufferArray()
public boolean	isNIOLongBuffer()
public boolean	isNIOPointerBuffer()
public boolean	isOpaqued()
public boolean	isPrimitive()
public boolean	isPrimitiveArray()
public boolean	isShort()
public boolean	isShortArray()
public boolean	isString()
public boolean	isStringArray()
public boolean	isVoid()
public String	jniTypeName() Returns the String corresponding to the JNI type for this type, or NULL if it can't be represented (i.e., it's a boxing class that we need to call getBuffer() on.)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

clazz	back to summary
private final Class<?> clazz

elementType	back to summary
private final Type elementType

nioBufferType	back to summary
private static JavaType nioBufferType

nioByteBufferArrayType	back to summary
private static JavaType nioByteBufferArrayType

nioByteBufferType	back to summary
private static JavaType nioByteBufferType

nioDoubleBufferType	back to summary
private static JavaType nioDoubleBufferType

nioFloatBufferType	back to summary
private static JavaType nioFloatBufferType

nioIntBufferType	back to summary
private static JavaType nioIntBufferType

nioLongBufferType	back to summary
private static JavaType nioLongBufferType

nioPointerBufferType	back to summary
private static JavaType nioPointerBufferType

nioShortBufferType	back to summary
private static JavaType nioShortBufferType

opaqued	back to summary
private final boolean opaqued

primitivePointerType	back to summary
private final JavaType.C_PTR primitivePointerType

structName	back to summary
private final String structName

Constructor Detail

JavaType	back to summary
private JavaType(final Class<?> clazz, final boolean opaqued) Constructs a representation for a type corresponding to the given Class argument.

JavaType	back to summary
private JavaType(final String structName) Constructs a type representing a named C struct.

JavaType	back to summary
private JavaType(final JavaType.C_PTR primitivePointerType) Constructs a type representing a pointer to a C primitive (integer, floating-point, or void pointer) type.

JavaType	back to summary
private JavaType(final Type elementType) Constructs a type representing an array of C pointers.

JavaType	back to summary
private JavaType(final JavaType.C_PTR primitivePointerType, final Class<?> clazz, final String name, final Type elementType) clone only

Method Detail

append	back to summary
private void append(final StringBuilder sb, final String val, final boolean prepComma)

arrayDescriptor	back to summary
private String arrayDescriptor(Class<?> clazz)

arrayName	back to summary
private String arrayName(Class<?> clazz)

clone back to summary

clone	back to summary
public Object clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:Object a clone of this instance. Annotations @Override

public Object clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:Object

a clone of this instance.

Annotations

@Override

createForCArray	back to summary
public static JavaType createForCArray(final Type elementType) Creates a JavaType corresponding to an array of the given element type. This is used to represent arrays of "Foo **" which should be mapped to Foo[] in Java.

createForCCharPointer	back to summary
public static JavaType createForCCharPointer()

createForCDoublePointer	back to summary
public static JavaType createForCDoublePointer()

createForCFloatPointer	back to summary
public static JavaType createForCFloatPointer()

createForCInt32Pointer	back to summary
public static JavaType createForCInt32Pointer()

createForCInt64Pointer	back to summary
public static JavaType createForCInt64Pointer()

createForClass	back to summary
public static JavaType createForClass(final Class<?> clazz) Creates a JavaType corresponding to the given Java type. This can be used to represent arrays of primitive values or Strings; the emitters understand how to perform proper conversion from the corresponding C type.

createForCShortPointer	back to summary
public static JavaType createForCShortPointer()

createForCStruct	back to summary
public static JavaType createForCStruct(final String name) Creates a JavaType corresponding to the specified C CompoundType name; for example, if "Foo" is supplied, then this JavaType represents a "Foo *" by way of a StructAccessor.

createForCVoidPointer	back to summary
public static JavaType createForCVoidPointer()

createForJNIEnv	back to summary
public static JavaType createForJNIEnv()

createForOpaqueClass	back to summary
public static JavaType createForOpaqueClass(final Class<?> clazz) Creates a JavaType corresponding to the given opaque Java type. This can be used to represent arrays of primitive values or Strings; the emitters understand how to perform proper conversion from the corresponding C type.

descriptor	back to summary
private String descriptor(final Class<?> clazz)

descriptor	back to summary
private String descriptor(final String referenceTypeName)

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

forNIOBufferClass	back to summary
public static JavaType forNIOBufferClass()

forNIOByteBufferArrayClass	back to summary
public static JavaType forNIOByteBufferArrayClass()

forNIOByteBufferClass	back to summary
public static JavaType forNIOByteBufferClass()

forNIODoubleBufferClass	back to summary
public static JavaType forNIODoubleBufferClass()

forNIOFloatBufferClass	back to summary
public static JavaType forNIOFloatBufferClass()

forNIOIntBufferClass	back to summary
public static JavaType forNIOIntBufferClass()

forNIOLongBufferClass	back to summary
public static JavaType forNIOLongBufferClass()

forNIOPointerBufferClass	back to summary
public static JavaType forNIOPointerBufferClass()

forNIOShortBufferClass	back to summary
public static JavaType forNIOShortBufferClass()

getDebugString	back to summary
public String getDebugString()

getDescriptor	back to summary
public String getDescriptor() Returns the descriptor (internal type signature) corresponding to this type.

getElementCType	back to summary
public Type getElementCType()

getElementType	back to summary
public JavaType getElementType()

getJavaClass	back to summary
public Class<?> getJavaClass() Returns the Java Class corresponding to this type. Returns null if this object corresponds to a C primitive array type.

getName	back to summary
public String getName() Returns the Java type name corresponding to this type.

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

isArray	back to summary
public boolean isArray()

isArrayOfCompoundTypeWrappers	back to summary
public boolean isArrayOfCompoundTypeWrappers()

isByte	back to summary
public boolean isByte()

isByteArray	back to summary
public boolean isByteArray()

isCCharPointerType	back to summary
public boolean isCCharPointerType()

isCDoublePointerType	back to summary
public boolean isCDoublePointerType()

isCFloatPointerType	back to summary
public boolean isCFloatPointerType()

isCInt32PointerType	back to summary
public boolean isCInt32PointerType()

isCInt64PointerType	back to summary
public boolean isCInt64PointerType()

isCompoundTypeWrapper	back to summary
public boolean isCompoundTypeWrapper()

isCPrimitivePointerType	back to summary
public boolean isCPrimitivePointerType()

isCShortPointerType	back to summary
public boolean isCShortPointerType()

isCVoidPointerType	back to summary
public boolean isCVoidPointerType()

isDouble	back to summary
public boolean isDouble()

isDoubleArray	back to summary
public boolean isDoubleArray()

isFloat	back to summary
public boolean isFloat()

isFloatArray	back to summary
public boolean isFloatArray()

isInt	back to summary
public boolean isInt()

isIntArray	back to summary
public boolean isIntArray()

isJNIEnv	back to summary
public boolean isJNIEnv()

isLong	back to summary
public boolean isLong()

isLongArray	back to summary
public boolean isLongArray()

isNIOBuffer	back to summary
public boolean isNIOBuffer()

isNIOBufferArray	back to summary
public boolean isNIOBufferArray()

isNIOByteBuffer	back to summary
public boolean isNIOByteBuffer()

isNIOByteBufferArray	back to summary
public boolean isNIOByteBufferArray()

isNIOLongBuffer	back to summary
public boolean isNIOLongBuffer()

isNIOPointerBuffer	back to summary
public boolean isNIOPointerBuffer()

isOpaqued	back to summary
public boolean isOpaqued()

isPrimitive	back to summary
public boolean isPrimitive()

isPrimitiveArray	back to summary
public boolean isPrimitiveArray()

isShort	back to summary
public boolean isShort()

isShortArray	back to summary
public boolean isShortArray()

isString	back to summary
public boolean isString()

isStringArray	back to summary
public boolean isStringArray()

isVoid	back to summary
public boolean isVoid()

jniTypeName	back to summary
public String jniTypeName() Returns the String corresponding to the JNI type for this type, or NULL if it can't be represented (i.e., it's a boxing class that we need to call getBuffer() on.)

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

com.jogamp.gluegen back to summary

private final Enum JavaType.C_PTR

Class Inheritance

extends Enum<JavaType.C_PTR>

java.lang.Object
java.lang.Enum
com.jogamp.gluegen.JavaType.C_PTR

Field Summary

Modifier and Type	Field and Description
public static final JavaType.C_PTR	CHAR
public static final JavaType.C_PTR	DOUBLE
public static final JavaType.C_PTR	FLOAT
public static final JavaType.C_PTR	INT32
public static final JavaType.C_PTR	INT64
public static final JavaType.C_PTR	SHORT
public static final JavaType.C_PTR	VOID

Constructor Summary

Access	Constructor and Description
private	C_PTR()

Method Summary

Modifier and Type	Method and Description
public static JavaType.C_PTR	valueOf(String name)
public static JavaType.C_PTR[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CHAR	back to summary
public static final JavaType.C_PTR CHAR

DOUBLE	back to summary
public static final JavaType.C_PTR DOUBLE

FLOAT	back to summary
public static final JavaType.C_PTR FLOAT

INT32	back to summary
public static final JavaType.C_PTR INT32

INT64	back to summary
public static final JavaType.C_PTR INT64

SHORT	back to summary
public static final JavaType.C_PTR SHORT

VOID	back to summary
public static final JavaType.C_PTR VOID

Constructor Detail

C_PTR	back to summary
private C_PTR()

Method Detail

valueOf	back to summary
public static JavaType.C_PTR valueOf(String name)

values	back to summary
public static JavaType.C_PTR[] values()

public Class JavaType

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum JavaType.C_PTR

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail