EclipseLink 2.4.2, build 'v20130514-5956486' API Reference

org.eclipse.persistence.jpa.jpql
Interface ITypeHelper

All Known Implementing Classes:
GenericTypeHelper

public interface ITypeHelper

Version:
2.4
Author:
Pascal Filion
Since:
2.4

Method Summary
 java.lang.Object bigDecimal()
          Retrieves the;@link IType} for;@link BigDecimal}.
 java.lang.Object bigInteger()
          Retrieves the;@link IType} for;@link BigInteger}.
 java.lang.Object booleanType()
          Retrieves the;@link IType} for;@link Boolean}.
 java.lang.Object byteType()
          Retrieves the;@link IType} for;@link Byte}.
 java.lang.Object characterType()
          Retrieves the;@link IType} for;@link Character}.
 java.lang.Object collectionType()
          Retrieves the;@link IType} for;@link Collection}.
 java.lang.Object convertPrimitive(java.lang.Object type)
          Converts the given;@link IType}, if it's representing a primitive type, into the class of the same type.
 java.lang.Object dateType()
          Retrieves the;@link IType} for;@link Date}.
 java.lang.Object doubleType()
          Retrieves the;@link IType} for;@link Double}.
 java.lang.Object enumType()
          Retrieves the;@link IType} for;@link Enum}.
 java.lang.Object floatType()
          Retrieves the;@link IType} for;@link Float}.
 java.lang.Object getType(java.lang.Class<?> type)
          Returns the;@link IType} of the given Java type.
 java.lang.Object getType(java.lang.String typeName)
          Retrieves the external class for the given fully qualified class name.
 java.lang.Object integerType()
          Retrieves the;@link IType} for;@link Integer}.
 boolean isBooleanType(java.lang.Object type)
          Determines whether the given;@link IType} is a;@link Boolean}.
 boolean isCollectionType(java.lang.Object type)
          Determines whether the given;@link IType} is an instance of;@link Collection}.
 boolean isDateType(java.lang.Object type)
          Determines whether the given;@link IType} is a;@link Date},;@link Timestamp} or ;@link Calendar}.
 boolean isEnumType(java.lang.Object type)
          Determines whether the given;@link IType} is an instance of;@link Enum}.
 boolean isFloatingType(java.lang.Object type)
          Determines whether the given;@link IType} is an instance of a floating type, which is either Float, Double, float or double.
 boolean isIntegralType(java.lang.Object type)
          Determines whether the given;@link IType} is an instance of a floating type, which is either Integer, Long, int or float.
 boolean isMapType(java.lang.Object type)
          Determines whether the given;@link IType} is an instance of;@link Map}.
 boolean isNumericType(java.lang.Object type)
          Determines whether the given;@link IType} is an instance of;@link Numeric}.
 boolean isObjectType(java.lang.Object type)
          Determines whether the given;@link IType} is the external form of;@link Object}.
 boolean isPrimitiveType(java.lang.Object type)
          Determines whether the given;@link IType} represents a primitive type.
 boolean isStringType(java.lang.Object type)
          Determines whether the given;@link IType} represents the String class.
 java.lang.Object longType()
          Retrieves the;@link IType} for;@link Long}.
 java.lang.Object longType(java.lang.Object type)
          Converts the given;@link IType}, if it's the primitive long, into the Long type.
 java.lang.Object mapType()
          Retrieves the;@link IType} for;@link Map}.
 java.lang.Object numberType()
          Retrieves the;@link IType} for;@link Number}.
 java.lang.Object objectType()
          Retrieves the;@link IType} for;@link Object}.
 java.lang.Object objectTypeDeclaration()
          Returns the;@link Object } for the;@link IType} representing the Object class.
 java.lang.Object primitiveBoolean()
          Retrieves the;@link IType} for the primitive boolean.
 java.lang.Object primitiveByte()
          Retrieves the;@link IType} for the primitive byte.
 java.lang.Object primitiveChar()
          Retrieves the;@link IType} for the primitive char.
 java.lang.Object primitiveDouble()
          Retrieves the;@link IType} for the primitive double.
 java.lang.Object primitiveFloat()
          Retrieves the;@link IType} for the primitive float.
 java.lang.Object primitiveInteger()
          Retrieves the;@link IType} for the primitive int.
 java.lang.Object primitiveLong()
          Retrieves the;@link IType} for the primitive long.
 java.lang.Object primitiveShort()
          Retrieves the;@link IType} for the primitive short.
 java.lang.Object shortType()
          Retrieves the;@link IType} for;@link Short}.
 java.lang.Object stringType()
          Retrieves the;@link IType} for;@link String}.
 java.lang.Object timestampType()
          Retrieves the;@link IType} for;@link Timestamp}.
 java.lang.Object toBooleanType(java.lang.Object type)
          Converts the given;@link IType}, if it's the primitive boolean, into the Boolean type.
 java.lang.Object toByteType(java.lang.Object type)
          Converts the given;@link IType}, if it's the primitive byte, into the Byte type.
 java.lang.Object toDoubleType(java.lang.Object type)
          Converts the given;@link IType}, if it's the primitive double, into the Double type.
 java.lang.Object toFloatType(java.lang.Object type)
          Converts the given;@link IType}, if it's the primitive float, into the Float type.
 java.lang.Object toIntegerType(java.lang.Object type)
          Converts the given;@link IType}, if it's the primitive int, into the Integer type.
 java.lang.Object toShortType(java.lang.Object type)
          Converts the given;@link IType}, if it's the primitive short, into the Short type.
 java.lang.Object unknownType()
          Retrieves the;@link IType} that represents an unknown type.
 java.lang.Object unknownTypeDeclaration()
          Returns the;@link Object } for the;@link IType} representing an unknown type.
 

Method Detail

bigDecimal

java.lang.Object bigDecimal()
Retrieves the;@link IType} for;@link BigDecimal}.

Returns:
The external form of the BigDecimal class

bigInteger

java.lang.Object bigInteger()
Retrieves the;@link IType} for;@link BigInteger}.

Returns:
The external form of the BigInteger class

booleanType

java.lang.Object booleanType()
Retrieves the;@link IType} for;@link Boolean}.

Returns:
The external form of the Boolean class

byteType

java.lang.Object byteType()
Retrieves the;@link IType} for;@link Byte}.

Returns:
The external form of the Byte class

characterType

java.lang.Object characterType()
Retrieves the;@link IType} for;@link Character}.

Returns:
The external form of the Character class

collectionType

java.lang.Object collectionType()
Retrieves the;@link IType} for;@link Collection}.

Returns:
The external form of the Collection class

convertPrimitive

java.lang.Object convertPrimitive(java.lang.Object type)
Converts the given;@link IType}, if it's representing a primitive type, into the class of the same type.

Parameters:
type - Type to possibly convert from the primitive into the class
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

dateType

java.lang.Object dateType()
Retrieves the;@link IType} for;@link Date}.

Returns:
The external form of the Date class

doubleType

java.lang.Object doubleType()
Retrieves the;@link IType} for;@link Double}.

Returns:
The external form of the Double class

enumType

java.lang.Object enumType()
Retrieves the;@link IType} for;@link Enum}.

Returns:
The external form of the Enum class

floatType

java.lang.Object floatType()
Retrieves the;@link IType} for;@link Float}.

Returns:
The external form of the Float class

getType

java.lang.Object getType(java.lang.Class<?> type)
Returns the;@link IType} of the given Java type.

Parameters:
type - The Java type for which its external form will be returned
Returns:
The;@link IType} representing the given Java type

getType

java.lang.Object getType(java.lang.String typeName)
Retrieves the external class for the given fully qualified class name.

Parameters:
typeName - The fully qualified class name of the class to retrieve
Returns:
The external form of the class to retrieve

integerType

java.lang.Object integerType()
Retrieves the;@link IType} for;@link Integer}.

Returns:
The external form of the Integer class

isBooleanType

boolean isBooleanType(java.lang.Object type)
Determines whether the given;@link IType} is a;@link Boolean}.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} is a;@link Boolean}; false otherwise

isCollectionType

boolean isCollectionType(java.lang.Object type)
Determines whether the given;@link IType} is an instance of;@link Collection}.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} is an instance of;@link Collection}; false otherwise

isDateType

boolean isDateType(java.lang.Object type)
Determines whether the given;@link IType} is a;@link Date},;@link Timestamp} or ;@link Calendar}.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} is a;@link Date},;@link Timestamp} or ;@link Calendar}

isEnumType

boolean isEnumType(java.lang.Object type)
Determines whether the given;@link IType} is an instance of;@link Enum}.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} is an instance of;@link Enum}; false otherwise

isFloatingType

boolean isFloatingType(java.lang.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 - The type to check it's assignability
Returns:
true if the given;@link IType} is a floating type; false otherwise

isIntegralType

boolean isIntegralType(java.lang.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 - The type to check it's assignability
Returns:
true if the given;@link IType} is a integral type; false otherwise

isMapType

boolean isMapType(java.lang.Object type)
Determines whether the given;@link IType} is an instance of;@link Map}.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} is an instance of;@link Map}; false otherwise

isNumericType

boolean isNumericType(java.lang.Object type)
Determines whether the given;@link IType} is an instance of;@link Numeric}.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} is an instance of;@link Numeric}; false otherwise

isObjectType

boolean isObjectType(java.lang.Object type)
Determines whether the given;@link IType} is the external form of;@link Object}.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} is the external form of;@link Object}

isPrimitiveType

boolean isPrimitiveType(java.lang.Object type)
Determines whether the given;@link IType} represents a primitive type.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} represents a primitive; false otherwise

isStringType

boolean isStringType(java.lang.Object type)
Determines whether the given;@link IType} represents the String class.

Parameters:
type - The type to check it's assignability
Returns:
true if the given;@link IType} represents the String class; false otherwise

longType

java.lang.Object longType()
Retrieves the;@link IType} for;@link Long}.

Returns:
The external form of the Long class

longType

java.lang.Object longType(java.lang.Object type)
Converts the given;@link IType}, if it's the primitive long, into the Long type.

Parameters:
type - The;@link IType} to possibly convert
Returns:
The given type if it's not the primitive long or the;@link IType} for the class Long

mapType

java.lang.Object mapType()
Retrieves the;@link IType} for;@link Map}.

Returns:
The external form of the Map class

numberType

java.lang.Object numberType()
Retrieves the;@link IType} for;@link Number}.

Returns:
The external form of the Number class

objectType

java.lang.Object objectType()
Retrieves the;@link IType} for;@link Object}.

Returns:
The external form of the Object class

objectTypeDeclaration

java.lang.Object objectTypeDeclaration()
Returns the;@link Object } for the;@link IType} representing the Object class.

Returns:
The;@link Object } of the Object class

primitiveBoolean

java.lang.Object primitiveBoolean()
Retrieves the;@link IType} for the primitive boolean.

Returns:
The external form of the primitive boolean

primitiveByte

java.lang.Object primitiveByte()
Retrieves the;@link IType} for the primitive byte.

Returns:
The external form of the primitive byte

primitiveChar

java.lang.Object primitiveChar()
Retrieves the;@link IType} for the primitive char.

Returns:
The external form of the primitive char

primitiveDouble

java.lang.Object primitiveDouble()
Retrieves the;@link IType} for the primitive double.

Returns:
The external form of the primitive double

primitiveFloat

java.lang.Object primitiveFloat()
Retrieves the;@link IType} for the primitive float.

Returns:
The external form of the primitive float

primitiveInteger

java.lang.Object primitiveInteger()
Retrieves the;@link IType} for the primitive int.

Returns:
The external form of the primitive int

primitiveLong

java.lang.Object primitiveLong()
Retrieves the;@link IType} for the primitive long.

Returns:
The external form of the primitive long

primitiveShort

java.lang.Object primitiveShort()
Retrieves the;@link IType} for the primitive short.

Returns:
The external form of the primitive short

shortType

java.lang.Object shortType()
Retrieves the;@link IType} for;@link Short}.

Returns:
The external form of the Short class

stringType

java.lang.Object stringType()
Retrieves the;@link IType} for;@link String}.

Returns:
The external form of the String class

timestampType

java.lang.Object timestampType()
Retrieves the;@link IType} for;@link Timestamp}.

Returns:
The external form of the Timestamp class

toBooleanType

java.lang.Object toBooleanType(java.lang.Object type)
Converts the given;@link IType}, if it's the primitive boolean, into the Boolean type.

Parameters:
type - The;@link IType} to possibly convert
Returns:
The given type if it's not the primitive boolean or the;@link IType} for the class Boolean

toByteType

java.lang.Object toByteType(java.lang.Object type)
Converts the given;@link IType}, if it's the primitive byte, into the Byte type.

Parameters:
type - The;@link IType} to possibly convert
Returns:
The given type if it's not the primitive byte or the;@link IType} for the class Byte

toDoubleType

java.lang.Object toDoubleType(java.lang.Object type)
Converts the given;@link IType}, if it's the primitive double, into the Double type.

Parameters:
type - The;@link IType} to possibly convert
Returns:
The given type if it's not the primitive double or the;@link IType} for the class Double

toFloatType

java.lang.Object toFloatType(java.lang.Object type)
Converts the given;@link IType}, if it's the primitive float, into the Float type.

Parameters:
type - The;@link IType} to possibly convert
Returns:
The given type if it's not the primitive float or the;@link IType} for the class Float

toIntegerType

java.lang.Object toIntegerType(java.lang.Object type)
Converts the given;@link IType}, if it's the primitive int, into the Integer type.

Parameters:
type - The;@link IType} to possibly convert
Returns:
The given type if it's not the primitive int or the;@link IType} for the class Integer

toShortType

java.lang.Object toShortType(java.lang.Object type)
Converts the given;@link IType}, if it's the primitive short, into the Short type.

Parameters:
type - The;@link IType} to possibly convert
Returns:
The given type if it's not the primitive short or the;@link IType} for the class Short

unknownType

java.lang.Object unknownType()
Retrieves the;@link IType} that represents an unknown type.

Returns:
The external form of an unknown type

unknownTypeDeclaration

java.lang.Object unknownTypeDeclaration()
Returns the;@link Object } for the;@link IType} representing an unknown type.

Returns:
The;@link Object } of the unknown type

EclipseLink 2.4.2, build 'v20130514-5956486' API Reference