Package org.eclipse.persistence.jpa.jpql.tools.spi

Interface ITypeDeclaration

public interface ITypeDeclaration

The external representation of a type declaration, which is used to give more information about the type, i.e. if it's an array and if it has parameter types.

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Version:

2.3

Author:

Pascal Filion

Since:

2.3

Method Summary

Modifier and Type	Method	Description
int	getDimensionality()	Returns the dimensionality of the type if (isArray() is true) or 0 if the type is not an array.
IType	getType()	Returns the type defined for the Java member.
ITypeDeclaration[]	getTypeParameters()	Returns the ITypeDeclarations that represent the variables declared by the generic declaration represented by this ITypeDeclaration.
boolean	isArray()	Determines whether this type represents an array or not.

Method Detail

getDimensionality

int getDimensionality()

Returns the dimensionality of the type if (isArray() is true) or 0 if the type is not an array.

Returns:

The array dimensionality if the IType is an array; otherwise 0

getType

IType getType()

Returns the type defined for the Java member.

Returns:

The type defined for the Java member

getTypeParameters

ITypeDeclaration[] getTypeParameters()

Returns the ITypeDeclarations that represent the variables declared by the generic declaration represented by this ITypeDeclaration.

Returns:

The array over the ITypeDeclarations

isArray

boolean isArray()

Determines whether this type represents an array or not.

Returns:

true if this type is an array; false otherwise