Top Methods
org.eclipse.persistence.jpa.jpql

public Interface ITypeHelper

Known Direct Implementers
org.eclipse.persistence.jpa.jpql.tools.GenericTypeHelper

Author
Pascal Filion
Since
2.4
Version
2.4

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

The external form of the BigDecimal class
bigDecimal
()

Retrieves the;@link IType} for;@link BigDecimal}.

public Object

Returns:

The external form of the BigInteger class
bigInteger
()

Retrieves the;@link IType} for;@link BigInteger}.

public Object

Returns:

The external form of the Boolean class
booleanType
()

Retrieves the;@link IType} for;@link Boolean}.

public Object

Returns:

The external form of the Byte class
byteType
()

Retrieves the;@link IType} for;@link Byte}.

public Object

Returns:

The external form of the Character class
characterType
()

Retrieves the;@link IType} for;@link Character}.

public Object

Returns:

The external form of the Collection class
collectionType
()

Retrieves the;@link IType} for;@link Collection}.

public Object

Returns:

The given;@link IType} if it's not a primitive type otherwise the primitive type will have been converted into the class of that primitive
convertPrimitive
(Object
Type to possibly convert from the primitive into the class
type
)

Converts the given;@link IType}, if it's representing a primitive type, into the class of the same type.

public Object

Returns:

The external form of the Date class
dateType
()

Retrieves the;@link IType} for;@link Date}.

public Object

Returns:

The external form of the Double class
doubleType
()

Retrieves the;@link IType} for;@link Double}.

public Object

Returns:

The external form of the Enum class
enumType
()

Retrieves the;@link IType} for;@link Enum}.

public Object

Returns:

The external form of the Float class
floatType
()

Retrieves the;@link IType} for;@link Float}.

public Object

Returns:

The;@link IType} representing the given Java type
getType
(Class<?>
The Java type for which its external form will be returned
type
)

Returns the;@link IType} of the given Java type.

public Object

Returns:

The external form of the class to retrieve
getType
(String
The fully qualified class name of the class to retrieve
typeName
)

Retrieves the external class for the given fully qualified class name.

public Object

Returns:

The external form of the Integer class
integerType
()

Retrieves the;@link IType} for;@link Integer}.

public boolean

Returns:

true if the given;@link IType} is a;@link Boolean}; false otherwise
isBooleanType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is a;@link Boolean}.

public boolean

Returns:

true if the given;@link IType} is an instance of;@link Collection}; false otherwise
isCollectionType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is an instance of;@link Collection}.

public boolean

Returns:

true if the given;@link IType} is a;@link Date},;@link Timestamp} or ;@link Calendar}
isDateType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is a;@link Date},;@link Timestamp} or ;@link Calendar}.

public boolean

Returns:

true if the given;@link IType} is an instance of;@link Enum}; false otherwise
isEnumType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is an instance of;@link Enum}.

public boolean

Returns:

true if the given;@link IType} is a floating type; false otherwise
isFloatingType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is an instance of a floating type, which is either Float, Double, float or double.

public boolean

Returns:

true if the given;@link IType} is a integral type; false otherwise
isIntegralType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is an instance of a floating type, which is either Integer, Long, int or float.

public boolean

Returns:

true if the given;@link IType} is an instance of;@link Map}; false otherwise
isMapType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is an instance of;@link Map}.

public boolean

Returns:

true if the given;@link IType} is an instance of;@link Numeric}; false otherwise
isNumericType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is an instance of;@link Numeric}.

public boolean

Returns:

true if the given;@link IType} is the external form of;@link Object}
isObjectType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} is the external form of;@link Object}.

public boolean

Returns:

true if the given;@link IType} represents a primitive; false otherwise
isPrimitiveType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} represents a primitive type.

public boolean

Returns:

true if the given;@link IType} represents the String class; false otherwise
isStringType
(Object
The type to check it's assignability
type
)

Determines whether the given;@link IType} represents the String class.

public Object

Returns:

The external form of the Long class
longType
()

Retrieves the;@link IType} for;@link Long}.

public Object

Returns:

The given type if it's not the primitive long or the;@link IType} for the class Long
longType
(Object
The;@link IType} to possibly convert
type
)

Converts the given;@link IType}, if it's the primitive long, into the Long type.

public Object

Returns:

The external form of the Map class
mapType
()

Retrieves the;@link IType} for;@link Map}.

public Object

Returns:

The external form of the Number class
numberType
()

Retrieves the;@link IType} for;@link Number}.

public Object

Returns:

The external form of the Object class
objectType
()

Retrieves the;@link IType} for;@link Object}.

public Object

Returns:

The;@link Object } of the Object class
objectTypeDeclaration
()

Returns the;@link Object } for the;@link IType} representing the Object class.

public Object

Returns:

The external form of the primitive boolean
primitiveBoolean
()

Retrieves the;@link IType} for the primitive boolean.

public Object

Returns:

The external form of the primitive byte
primitiveByte
()

Retrieves the;@link IType} for the primitive byte.

public Object

Returns:

The external form of the primitive char
primitiveChar
()

Retrieves the;@link IType} for the primitive char.

public Object

Returns:

The external form of the primitive double
primitiveDouble
()

Retrieves the;@link IType} for the primitive double.

public Object

Returns:

The external form of the primitive float
primitiveFloat
()

Retrieves the;@link IType} for the primitive float.

public Object

Returns:

The external form of the primitive int
primitiveInteger
()

Retrieves the;@link IType} for the primitive int.

public Object

Returns:

The external form of the primitive long
primitiveLong
()

Retrieves the;@link IType} for the primitive long.

public Object

Returns:

The external form of the primitive short
primitiveShort
()

Retrieves the;@link IType} for the primitive short.

public Object

Returns:

The external form of the Short class
shortType
()

Retrieves the;@link IType} for;@link Short}.

public Object

Returns:

The external form of the String class
stringType
()

Retrieves the;@link IType} for;@link String}.

public Object

Returns:

The external form of the Timestamp class
timestampType
()

Retrieves the;@link IType} for;@link Timestamp}.

public Object

Returns:

The given type if it's not the primitive boolean or the;@link IType} for the class Boolean
toBooleanType
(Object
The;@link IType} to possibly convert
type
)

Converts the given;@link IType}, if it's the primitive boolean, into the Boolean type.

public Object

Returns:

The given type if it's not the primitive byte or the;@link IType} for the class Byte
toByteType
(Object
The;@link IType} to possibly convert
type
)

Converts the given;@link IType}, if it's the primitive byte, into the Byte type.

public Object

Returns:

The given type if it's not the primitive double or the;@link IType} for the class Double
toDoubleType
(Object
The;@link IType} to possibly convert
type
)

Converts the given;@link IType}, if it's the primitive double, into the Double type.

public Object

Returns:

The given type if it's not the primitive float or the;@link IType} for the class Float
toFloatType
(Object
The;@link IType} to possibly convert
type
)

Converts the given;@link IType}, if it's the primitive float, into the Float type.

public Object

Returns:

The given type if it's not the primitive int or the;@link IType} for the class Integer
toIntegerType
(Object
The;@link IType} to possibly convert
type
)

Converts the given;@link IType}, if it's the primitive int, into the Integer type.

public Object

Returns:

The given type if it's not the primitive short or the;@link IType} for the class Short
toShortType
(Object
The;@link IType} to possibly convert
type
)

Converts the given;@link IType}, if it's the primitive short, into the Short type.

public Object

Returns:

The external form of an unknown type
unknownType
()

Retrieves the;@link IType} that represents an unknown type.

public Object

Returns:

The;@link Object } of the unknown type
unknownTypeDeclaration
()

Returns the;@link Object } for the;@link IType} representing an unknown type.

Method Detail

bigDecimalback to summary
public Object bigDecimal()

Retrieves the;@link IType} for;@link BigDecimal}.

Returns:Object

The external form of the BigDecimal class

bigIntegerback to summary
public Object bigInteger()

Retrieves the;@link IType} for;@link BigInteger}.

Returns:Object

The external form of the BigInteger class

booleanTypeback to summary
public Object booleanType()

Retrieves the;@link IType} for;@link Boolean}.

Returns:Object

The external form of the Boolean class

byteTypeback to summary
public Object byteType()

Retrieves the;@link IType} for;@link Byte}.

Returns:Object

The external form of the Byte class

characterTypeback to summary
public Object characterType()

Retrieves the;@link IType} for;@link Character}.

Returns:Object

The external form of the Character class

collectionTypeback to summary
public Object collectionType()

Retrieves the;@link IType} for;@link Collection}.

Returns:Object

The external form of the Collection class

convertPrimitiveback to summary
public Object convertPrimitive(Object type)

Converts the given;@link IType}, if it's representing a primitive type, into the class of the same type.

Parameters
type:Object

Type to possibly convert from the primitive into the class

Returns:Object

The given;@link IType} if it's not a primitive type otherwise the primitive type will have been converted into the class of that primitive

dateTypeback to summary
public Object dateType()

Retrieves the;@link IType} for;@link Date}.

Returns:Object

The external form of the Date class

doubleTypeback to summary
public Object doubleType()

Retrieves the;@link IType} for;@link Double}.

Returns:Object

The external form of the Double class

enumTypeback to summary
public Object enumType()

Retrieves the;@link IType} for;@link Enum}.

Returns:Object

The external form of the Enum class

floatTypeback to summary
public Object floatType()

Retrieves the;@link IType} for;@link Float}.

Returns:Object

The external form of the Float class

getTypeback to summary
public Object getType(Class<?> type)

Returns the;@link IType} of the given Java type.

Parameters
type:Class<?>

The Java type for which its external form will be returned

Returns:Object

The;@link IType} representing the given Java type

getTypeback to summary
public Object getType(String typeName)

Retrieves the external class for the given fully qualified class name.

Parameters
typeName:String

The fully qualified class name of the class to retrieve

Returns:Object

The external form of the class to retrieve

integerTypeback to summary
public Object integerType()

Retrieves the;@link IType} for;@link Integer}.

Returns:Object

The external form of the Integer class

isBooleanTypeback to summary
public boolean isBooleanType(Object type)

Determines whether the given;@link IType} is a;@link Boolean}.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is a;@link Boolean}; false otherwise

isCollectionTypeback to summary
public boolean isCollectionType(Object type)

Determines whether the given;@link IType} is an instance of;@link Collection}.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is an instance of;@link Collection}; false otherwise

isDateTypeback to summary
public boolean isDateType(Object type)

Determines whether the given;@link IType} is a;@link Date},;@link Timestamp} or ;@link Calendar}.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is a;@link Date},;@link Timestamp} or ;@link Calendar}

isEnumTypeback to summary
public boolean isEnumType(Object type)

Determines whether the given;@link IType} is an instance of;@link Enum}.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is an instance of;@link Enum}; false otherwise

isFloatingTypeback to summary
public boolean isFloatingType(Object type)

Determines whether the given;@link IType} is an instance of a floating type, which is either Float, Double, float or double.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is a floating type; false otherwise

isIntegralTypeback to summary
public boolean isIntegralType(Object type)

Determines whether the given;@link IType} is an instance of a floating type, which is either Integer, Long, int or float.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is a integral type; false otherwise

isMapTypeback to summary
public boolean isMapType(Object type)

Determines whether the given;@link IType} is an instance of;@link Map}.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is an instance of;@link Map}; false otherwise

isNumericTypeback to summary
public boolean isNumericType(Object type)

Determines whether the given;@link IType} is an instance of;@link Numeric}.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is an instance of;@link Numeric}; false otherwise

isObjectTypeback to summary
public boolean isObjectType(Object type)

Determines whether the given;@link IType} is the external form of;@link Object}.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} is the external form of;@link Object}

isPrimitiveTypeback to summary
public boolean isPrimitiveType(Object type)

Determines whether the given;@link IType} represents a primitive type.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} represents a primitive; false otherwise

isStringTypeback to summary
public boolean isStringType(Object type)

Determines whether the given;@link IType} represents the String class.

Parameters
type:Object

The type to check it's assignability

Returns:boolean

true if the given;@link IType} represents the String class; false otherwise

longTypeback to summary
public Object longType()

Retrieves the;@link IType} for;@link Long}.

Returns:Object

The external form of the Long class

longTypeback to summary
public Object longType(Object type)

Converts the given;@link IType}, if it's the primitive long, into the Long type.

Parameters
type:Object

The;@link IType} to possibly convert

Returns:Object

The given type if it's not the primitive long or the;@link IType} for the class Long

mapTypeback to summary
public Object mapType()

Retrieves the;@link IType} for;@link Map}.

Returns:Object

The external form of the Map class

numberTypeback to summary
public Object numberType()

Retrieves the;@link IType} for;@link Number}.

Returns:Object

The external form of the Number class

objectTypeback to summary
public Object objectType()

Retrieves the;@link IType} for;@link Object}.

Returns:Object

The external form of the Object class

objectTypeDeclarationback to summary
public Object objectTypeDeclaration()

Returns the;@link Object } for the;@link IType} representing the Object class.

Returns:Object

The;@link Object } of the Object class

primitiveBooleanback to summary
public Object primitiveBoolean()

Retrieves the;@link IType} for the primitive boolean.

Returns:Object

The external form of the primitive boolean

primitiveByteback to summary
public Object primitiveByte()

Retrieves the;@link IType} for the primitive byte.

Returns:Object

The external form of the primitive byte

primitiveCharback to summary
public Object primitiveChar()

Retrieves the;@link IType} for the primitive char.

Returns:Object

The external form of the primitive char

primitiveDoubleback to summary
public Object primitiveDouble()

Retrieves the;@link IType} for the primitive double.

Returns:Object

The external form of the primitive double

primitiveFloatback to summary
public Object primitiveFloat()

Retrieves the;@link IType} for the primitive float.

Returns:Object

The external form of the primitive float

primitiveIntegerback to summary
public Object primitiveInteger()

Retrieves the;@link IType} for the primitive int.

Returns:Object

The external form of the primitive int

primitiveLongback to summary
public Object primitiveLong()

Retrieves the;@link IType} for the primitive long.

Returns:Object

The external form of the primitive long

primitiveShortback to summary
public Object primitiveShort()

Retrieves the;@link IType} for the primitive short.

Returns:Object

The external form of the primitive short

shortTypeback to summary
public Object shortType()

Retrieves the;@link IType} for;@link Short}.

Returns:Object

The external form of the Short class

stringTypeback to summary
public Object stringType()

Retrieves the;@link IType} for;@link String}.

Returns:Object

The external form of the String class

timestampTypeback to summary
public Object timestampType()

Retrieves the;@link IType} for;@link Timestamp}.

Returns:Object

The external form of the Timestamp class

toBooleanTypeback to summary
public Object toBooleanType(Object type)

Converts the given;@link IType}, if it's the primitive boolean, into the Boolean type.

Parameters
type:Object

The;@link IType} to possibly convert

Returns:Object

The given type if it's not the primitive boolean or the;@link IType} for the class Boolean

toByteTypeback to summary
public Object toByteType(Object type)

Converts the given;@link IType}, if it's the primitive byte, into the Byte type.

Parameters
type:Object

The;@link IType} to possibly convert

Returns:Object

The given type if it's not the primitive byte or the;@link IType} for the class Byte

toDoubleTypeback to summary
public Object toDoubleType(Object type)

Converts the given;@link IType}, if it's the primitive double, into the Double type.

Parameters
type:Object

The;@link IType} to possibly convert

Returns:Object

The given type if it's not the primitive double or the;@link IType} for the class Double

toFloatTypeback to summary
public Object toFloatType(Object type)

Converts the given;@link IType}, if it's the primitive float, into the Float type.

Parameters
type:Object

The;@link IType} to possibly convert

Returns:Object

The given type if it's not the primitive float or the;@link IType} for the class Float

toIntegerTypeback to summary
public Object toIntegerType(Object type)

Converts the given;@link IType}, if it's the primitive int, into the Integer type.

Parameters
type:Object

The;@link IType} to possibly convert

Returns:Object

The given type if it's not the primitive int or the;@link IType} for the class Integer

toShortTypeback to summary
public Object toShortType(Object type)

Converts the given;@link IType}, if it's the primitive short, into the Short type.

Parameters
type:Object

The;@link IType} to possibly convert

Returns:Object

The given type if it's not the primitive short or the;@link IType} for the class Short

unknownTypeback to summary
public Object unknownType()

Retrieves the;@link IType} that represents an unknown type.

Returns:Object

The external form of an unknown type

unknownTypeDeclarationback to summary
public Object unknownTypeDeclaration()

Returns the;@link Object } for the;@link IType} representing an unknown type.

Returns:Object

The;@link Object } of the unknown type