EclipseLink Hermes Parser 4.0.2 · org.eclipse.persistence.jpa.jpql.tools.TypeHelper

Modifier and Type	Field and Description
private IType	objectType The `IType` for the `Object` class.
private IType	stringType The `IType` for the `String` class.
private final ITypeRepository	typeRepository The external form of the provider of `ITypes`.
private IType	unknownType The `IType` representing an unknown type.

Access	Constructor and Description
public	TypeHelper(ITypeRepository The repository used to retrieve the types typeRepository) Creates a new `TypeHelper`.

Method Summary

Modifier and Type	Method and Description
public IType	Returns: The external form of the `BigDecimal` class bigDecimal() Retrieves the `IType` for `BigDecimal`.
public IType	Returns: The external form of the `BigInteger` class bigInteger() Retrieves the `IType` for `BigInteger`.
public IType	Returns: The external form of the `Boolean` class booleanType() Retrieves the `IType` for `Boolean`.
public IType	Returns: The external form of the `Byte` class byteType() Retrieves the `IType` for `Byte`.
public IType	Returns: The external form of the `Character` class characterType() Retrieves the `IType` for `Character`.
public IType	Returns: The external form of the `Collection` class collectionType() Retrieves the `IType` for `Collection`.
public IType	Returns: The given `IType` if it's not a primitive type otherwise the primitive type will have been converted into the class of that primitive convertPrimitive(IType Type to possibly convert from the primitive into the class type) Converts the given `IType`, if it's representing a primitive type, into the class of the same type.
public IType	Returns: The external form of the `Date` class dateType() Retrieves the `IType` for `Date`.
public IType	Returns: The external form of the `Double` class doubleType() Retrieves the `IType` for `Double`.
public IType	Returns: The external form of the `Enum` class enumType() Retrieves the `IType` for `Enum`.
public IType	Returns: The external form of the `Float` class floatType() Retrieves the `IType` for `Float`.
public IType	Returns: The `IType` representing the given Java type getType(Class<?> The Java type for which its external form will be returned type) Returns the `IType` of the given Java type.
public IType	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 ITypeRepository	Returns: The external form of the provider of `ITypes`. getTypeRepository() Returns the `ITypeRepository` used by this helper
public IType	Returns: The external form of the `Integer` class integerType() Retrieves the `IType` for `Integer`.
public boolean	Returns: `true` if the given `IType` is a `Boolean`; `false` otherwise isBooleanType(IType The type to check it's assignability type) Determines whether the given `IType` is a `Boolean`.
public boolean	Returns: `true` if the given `IType` is an instance of `Collection`; `false` otherwise isCollectionType(IType The type to check it's assignability type) Determines whether the given `IType` is an instance of `Collection`.
public boolean	Returns: `true` if the given `IType` is a `Date`, `Timestamp` or `Calendar` isDateType(IType The type to check it's assignability type) Determines whether the given `IType` is a `Date`, `Timestamp` or `Calendar`.
public boolean	Returns: `true` if the given `IType` is an instance of `Enum`; `false` otherwise isEnumType(IType The type to check it's assignability type) Determines whether the given `IType` is an instance of `Enum`.
public boolean	Returns: `true` if the given `IType` is a floating type; `false` otherwise isFloatingType(IType The type to check it's assignability type) Determines whether the given `IType` is an instance of a floating type, which is either `Float`, `Double`, float or double.
public boolean	Returns: `true` if the given `IType` is a integral type; `false` otherwise isIntegralType(IType The type to check it's assignability type) Determines whether the given `IType` is an instance of a floating type, which is either `Integer`, `Long`, int or float.
public boolean	Returns: `true` if the given `IType` is an instance of `Map`; `false` otherwise isMapType(IType The type to check it's assignability type) Determines whether the given `IType` is an instance of `Map`.
public boolean	Returns: `true` if the given `IType` is an instance of `Number`; `false` otherwise isNumericType(IType The type to check it's assignability type) Determines whether the given `IType` is an instance of `Number`.
public boolean	Returns: `true` if the given `IType` is the external form of `Object` isObjectType(IType The type to check it's assignability type) Determines whether the given `IType` is the external form of `Object`.
public boolean	Returns: `true` if the given `IType` represents a primitive; `false` otherwise isPrimitiveType(IType The type to check it's assignability type) Determines whether the given `IType` represents a primitive type.
public boolean	Returns: `true` if the given `IType` represents the `String` class; `false` otherwise isStringType(IType The type to check it's assignability type) Determines whether the given `IType` represents the `String` class.
public IType	Returns: The external form of the `Long` class longType() Retrieves the `IType` for `Long`.
public IType	Returns: The given type if it's not the primitive long or the `IType` for the class `Long` longType(IType The `IType` to possibly convert type) Converts the given `IType`, if it's the primitive long, into the `Long` type.
public IType	Returns: The external form of the `Map` class mapType() Retrieves the `IType` for `Map`.
public IType	Returns: The external form of the `Number` class numberType() Retrieves the `IType` for `Number`.
public IType	Returns: The external form of the `Object` class objectType() Retrieves the `IType` for `Object`.
public ITypeDeclaration	Returns: The `ITypeDeclaration` of the `Object` class objectTypeDeclaration() Returns the `ITypeDeclaration` for the `IType` representing the `Object` class.
public IType	Returns: The external form of the primitive boolean primitiveBoolean() Retrieves the `IType` for the primitive boolean.
public IType	Returns: The external form of the primitive byte primitiveByte() Retrieves the `IType` for the primitive byte.
public IType	Returns: The external form of the primitive char primitiveChar() Retrieves the `IType` for the primitive char.
public IType	Returns: The external form of the primitive double primitiveDouble() Retrieves the `IType` for the primitive double.
public IType	Returns: The external form of the primitive float primitiveFloat() Retrieves the `IType` for the primitive float.
public IType	Returns: The external form of the primitive int primitiveInteger() Retrieves the `IType` for the primitive int.
public IType	Returns: The external form of the primitive long primitiveLong() Retrieves the `IType` for the primitive long.
public IType	Returns: The external form of the primitive short primitiveShort() Retrieves the `IType` for the primitive short.
public IType	Returns: The external form of the `Short` class shortType() Retrieves the `IType` for `Short`.
public IType	Returns: The external form of the `String` class stringType() Retrieves the `IType` for `String`.
public IType	Returns: The external form of the `Timestamp` class timestampType() Retrieves the `IType` for `Timestamp`.
public IType	Returns: The given type if it's not the primitive boolean or the `IType` for the class `Boolean` toBooleanType(IType The `IType` to possibly convert type) Converts the given `IType`, if it's the primitive boolean, into the `Boolean` type.
public IType	Returns: The given type if it's not the primitive byte or the `IType` for the class `Byte` toByteType(IType The `IType` to possibly convert type) Converts the given `IType`, if it's the primitive byte, into the `Byte` type.
public IType	Returns: The given type if it's not the primitive double or the `IType` for the class `Double` toDoubleType(IType The `IType` to possibly convert type) Converts the given `IType`, if it's the primitive double, into the `Double` type.
public IType	Returns: The given type if it's not the primitive float or the `IType` for the class `Float` toFloatType(IType The `IType` to possibly convert type) Converts the given `IType`, if it's the primitive float, into the `Float` type.
public IType	Returns: The given type if it's not the primitive int or the `IType` for the class `Integer` toIntegerType(IType The `IType` to possibly convert type) Converts the given `IType`, if it's the primitive int, into the `Integer` type.
public IType	Returns: The given type if it's not the primitive short or the `IType` for the class `Short` toShortType(IType The `IType` to possibly convert type) Converts the given `IType`, if it's the primitive short, into the `Short` type.
public IType	Returns: The external form of an unknown type unknownType() Retrieves the `IType` that represents an unknown type.
public ITypeDeclaration	Returns: The `ITypeDeclaration` of the unknown type unknownTypeDeclaration() Returns the `ITypeDeclaration` for the `IType` representing an unknown type.

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

objectType	back to summary
private IType objectType The `IType` for the `Object` class.

stringType	back to summary
private IType stringType The `IType` for the `String` class.

typeRepository	back to summary
private final ITypeRepository typeRepository The external form of the provider of `ITypes`.

unknownType	back to summary
private IType unknownType The `IType` representing an unknown type.

TypeHelper	back to summary
public TypeHelper(ITypeRepository typeRepository) Creates a new `TypeHelper`. Parameters typeRepository:ITypeRepository The repository used to retrieve the types

Method Detail

bigDecimal back to summary

bigDecimal	back to summary
public IType bigDecimal() Retrieves the `IType` for `BigDecimal`. Returns:IType The external form of the `BigDecimal` class

public IType bigDecimal()

Retrieves the IType for BigDecimal.

Returns:IType: The external form of the BigDecimal class

bigInteger back to summary

bigInteger	back to summary
public IType bigInteger() Retrieves the `IType` for `BigInteger`. Returns:IType The external form of the `BigInteger` class

public IType bigInteger()

Retrieves the IType for BigInteger.

Returns:IType: The external form of the BigInteger class

booleanType back to summary

booleanType	back to summary
public IType booleanType() Retrieves the `IType` for `Boolean`. Returns:IType The external form of the `Boolean` class

public IType booleanType()

Retrieves the IType for Boolean.

Returns:IType: The external form of the Boolean class

byteType back to summary

byteType	back to summary
public IType byteType() Retrieves the `IType` for `Byte`. Returns:IType The external form of the `Byte` class

public IType byteType()

Retrieves the IType for Byte.

Returns:IType: The external form of the Byte class

characterType back to summary

characterType	back to summary
public IType characterType() Retrieves the `IType` for `Character`. Returns:IType The external form of the `Character` class

public IType characterType()

Retrieves the IType for Character.

Returns:IType: The external form of the Character class

collectionType back to summary

collectionType	back to summary
public IType collectionType() Retrieves the `IType` for `Collection`. Returns:IType The external form of the `Collection` class

public IType collectionType()

Retrieves the IType for Collection.

Returns:IType: The external form of the Collection class

convertPrimitive back to summary

convertPrimitive	back to summary
public IType convertPrimitive(IType type) Converts the given `IType`, if it's representing a primitive type, into the class of the same type. Parameters type:IType Type to possibly convert from the primitive into the class Returns:IType The given `IType` if it's not a primitive type otherwise the primitive type will have been converted into the class of that primitive

public IType convertPrimitive(IType type)

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

Parameters

type:IType: Type to possibly convert from the primitive into the class

Returns:IType

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

dateType back to summary

dateType	back to summary
public IType dateType() Retrieves the `IType` for `Date`. Returns:IType The external form of the `Date` class

public IType dateType()

Retrieves the IType for Date.

Returns:IType: The external form of the Date class

doubleType back to summary

doubleType	back to summary
public IType doubleType() Retrieves the `IType` for `Double`. Returns:IType The external form of the `Double` class

public IType doubleType()

Retrieves the IType for Double.

Returns:IType: The external form of the Double class

enumType back to summary

enumType	back to summary
public IType enumType() Retrieves the `IType` for `Enum`. Returns:IType The external form of the `Enum` class

public IType enumType()

Retrieves the IType for Enum.

Returns:IType: The external form of the Enum class

floatType back to summary

floatType	back to summary
public IType floatType() Retrieves the `IType` for `Float`. Returns:IType The external form of the `Float` class

public IType floatType()

Retrieves the IType for Float.

Returns:IType: The external form of the Float class

getType back to summary

getType	back to summary
public IType getType(Class<?> type) Returns the `IType` of the given Java type. Parameters type:Class<?> The Java type for which its external form will be returned Returns:IType The `IType` representing the given Java type

public IType getType(Class<?> type)

Returns the IType of the given Java type.

Parameters

type:Class<?>: The Java type for which its external form will be returned

Returns:IType

The IType representing the given Java type

getType	back to summary
public IType 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:IType The external form of the class to retrieve

getType

back to summary

public IType 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:IType

The external form of the class to retrieve

getTypeRepository back to summary

getTypeRepository	back to summary
public ITypeRepository getTypeRepository() Returns the `ITypeRepository` used by this helper Returns:ITypeRepository The external form of the provider of `ITypes`.

public ITypeRepository getTypeRepository()

Returns the ITypeRepository used by this helper

Returns:ITypeRepository: The external form of the provider of ITypes.

integerType back to summary

integerType	back to summary
public IType integerType() Retrieves the `IType` for `Integer`. Returns:IType The external form of the `Integer` class

public IType integerType()

Retrieves the IType for Integer.

Returns:IType: The external form of the Integer class

isBooleanType back to summary

isBooleanType	back to summary
public boolean isBooleanType(IType type) Determines whether the given `IType` is a `Boolean`. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is a `Boolean`; `false` otherwise

public boolean isBooleanType(IType type)

Determines whether the given IType is a Boolean.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

true if the given IType is a Boolean; false otherwise

isCollectionType back to summary

isCollectionType	back to summary
public boolean isCollectionType(IType type) Determines whether the given `IType` is an instance of `Collection`. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is an instance of `Collection`; `false` otherwise

public boolean isCollectionType(IType type)

Determines whether the given IType is an instance of Collection.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

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

isDateType back to summary

isDateType	back to summary
public boolean isDateType(IType type) Determines whether the given `IType` is a `Date`, `Timestamp` or `Calendar`. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is a `Date`, `Timestamp` or `Calendar`

public boolean isDateType(IType type)

Determines whether the given IType is a Date, Timestamp or Calendar.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

true if the given IType is a Date, Timestamp or Calendar

isEnumType back to summary

isEnumType	back to summary
public boolean isEnumType(IType type) Determines whether the given `IType` is an instance of `Enum`. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is an instance of `Enum`; `false` otherwise

public boolean isEnumType(IType type)

Determines whether the given IType is an instance of Enum.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

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

isFloatingType back to summary

isFloatingType	back to summary
public boolean isFloatingType(IType type) Determines whether the given `IType` is an instance of a floating type, which is either `Float`, `Double`, float or double. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is a floating type; `false` otherwise

public boolean isFloatingType(IType type)

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

Parameters

type:IType: The type to check it's assignability

Returns:boolean

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

isIntegralType back to summary

isIntegralType	back to summary
public boolean isIntegralType(IType type) Determines whether the given `IType` is an instance of a floating type, which is either `Integer`, `Long`, int or float. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is a integral type; `false` otherwise

public boolean isIntegralType(IType type)

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

Parameters

type:IType: The type to check it's assignability

Returns:boolean

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

isMapType back to summary

isMapType	back to summary
public boolean isMapType(IType type) Determines whether the given `IType` is an instance of `Map`. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is an instance of `Map`; `false` otherwise

public boolean isMapType(IType type)

Determines whether the given IType is an instance of Map.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

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

isNumericType back to summary

isNumericType	back to summary
public boolean isNumericType(IType type) Determines whether the given `IType` is an instance of `Number`. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is an instance of `Number`; `false` otherwise

public boolean isNumericType(IType type)

Determines whether the given IType is an instance of Number.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

true if the given IType is an instance of Number; false otherwise

isObjectType back to summary

isObjectType	back to summary
public boolean isObjectType(IType type) Determines whether the given `IType` is the external form of `Object`. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` is the external form of `Object`

public boolean isObjectType(IType type)

Determines whether the given IType is the external form of Object.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

true if the given IType is the external form of Object

isPrimitiveType back to summary

isPrimitiveType	back to summary
public boolean isPrimitiveType(IType type) Determines whether the given `IType` represents a primitive type. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` represents a primitive; `false` otherwise

public boolean isPrimitiveType(IType type)

Determines whether the given IType represents a primitive type.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

true if the given IType represents a primitive; false otherwise

isStringType back to summary

isStringType	back to summary
public boolean isStringType(IType type) Determines whether the given `IType` represents the `String` class. Parameters type:IType The type to check it's assignability Returns:boolean `true` if the given `IType` represents the `String` class; `false` otherwise

public boolean isStringType(IType type)

Determines whether the given IType represents the String class.

Parameters

type:IType: The type to check it's assignability

Returns:boolean

true if the given IType represents the String class; false otherwise

longType back to summary

longType	back to summary
public IType longType() Retrieves the `IType` for `Long`. Returns:IType The external form of the `Long` class

public IType longType()

Retrieves the IType for Long.

Returns:IType: The external form of the Long class

longType back to summary

longType	back to summary
public IType longType(IType type) Converts the given `IType`, if it's the primitive long, into the `Long` type. Parameters type:IType The `IType` to possibly convert Returns:IType The given type if it's not the primitive long or the `IType` for the class `Long`

public IType longType(IType type)

Converts the given IType, if it's the primitive long, into the Long type.

Parameters

type:IType: The IType to possibly convert

Returns:IType

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

mapType back to summary

mapType	back to summary
public IType mapType() Retrieves the `IType` for `Map`. Returns:IType The external form of the `Map` class

public IType mapType()

Retrieves the IType for Map.

Returns:IType: The external form of the Map class

numberType back to summary

numberType	back to summary
public IType numberType() Retrieves the `IType` for `Number`. Returns:IType The external form of the `Number` class

public IType numberType()

Retrieves the IType for Number.

Returns:IType: The external form of the Number class

objectType back to summary

objectType	back to summary
public IType objectType() Retrieves the `IType` for `Object`. Returns:IType The external form of the `Object` class

public IType objectType()

Retrieves the IType for Object.

Returns:IType: The external form of the Object class

objectTypeDeclaration back to summary

objectTypeDeclaration	back to summary
public ITypeDeclaration objectTypeDeclaration() Returns the `ITypeDeclaration` for the `IType` representing the `Object` class. Returns:ITypeDeclaration The `ITypeDeclaration` of the `Object` class

public ITypeDeclaration objectTypeDeclaration()

Returns the ITypeDeclaration for the IType representing the Object class.

Returns:ITypeDeclaration: The ITypeDeclaration of the Object class

primitiveBoolean back to summary

primitiveBoolean	back to summary
public IType primitiveBoolean() Retrieves the `IType` for the primitive boolean. Returns:IType The external form of the primitive boolean

public IType primitiveBoolean()

Retrieves the IType for the primitive boolean.

Returns:IType: The external form of the primitive boolean

primitiveByte back to summary

primitiveByte	back to summary
public IType primitiveByte() Retrieves the `IType` for the primitive byte. Returns:IType The external form of the primitive byte

public IType primitiveByte()

Retrieves the IType for the primitive byte.

Returns:IType: The external form of the primitive byte

primitiveChar back to summary

primitiveChar	back to summary
public IType primitiveChar() Retrieves the `IType` for the primitive char. Returns:IType The external form of the primitive char

public IType primitiveChar()

Retrieves the IType for the primitive char.

Returns:IType: The external form of the primitive char

primitiveDouble back to summary

primitiveDouble	back to summary
public IType primitiveDouble() Retrieves the `IType` for the primitive double. Returns:IType The external form of the primitive double

public IType primitiveDouble()

Retrieves the IType for the primitive double.

Returns:IType: The external form of the primitive double

primitiveFloat back to summary

primitiveFloat	back to summary
public IType primitiveFloat() Retrieves the `IType` for the primitive float. Returns:IType The external form of the primitive float

public IType primitiveFloat()

Retrieves the IType for the primitive float.

Returns:IType: The external form of the primitive float

primitiveInteger back to summary

primitiveInteger	back to summary
public IType primitiveInteger() Retrieves the `IType` for the primitive int. Returns:IType The external form of the primitive int

public IType primitiveInteger()

Retrieves the IType for the primitive int.

Returns:IType: The external form of the primitive int

primitiveLong back to summary

primitiveLong	back to summary
public IType primitiveLong() Retrieves the `IType` for the primitive long. Returns:IType The external form of the primitive long

public IType primitiveLong()

Retrieves the IType for the primitive long.

Returns:IType: The external form of the primitive long

primitiveShort back to summary

primitiveShort	back to summary
public IType primitiveShort() Retrieves the `IType` for the primitive short. Returns:IType The external form of the primitive short

public IType primitiveShort()

Retrieves the IType for the primitive short.

Returns:IType: The external form of the primitive short

shortType back to summary

shortType	back to summary
public IType shortType() Retrieves the `IType` for `Short`. Returns:IType The external form of the `Short` class

public IType shortType()

Retrieves the IType for Short.

Returns:IType: The external form of the Short class

stringType back to summary

stringType	back to summary
public IType stringType() Retrieves the `IType` for `String`. Returns:IType The external form of the `String` class

public IType stringType()

Retrieves the IType for String.

Returns:IType: The external form of the String class

timestampType back to summary

public IType timestampType()

Retrieves the IType for Timestamp.

Returns:IType: The external form of the Timestamp class

toBooleanType back to summary

public IType toBooleanType(IType type)

Converts the given IType, if it's the primitive boolean, into the Boolean type.

Parameters

type:IType: The IType to possibly convert

Returns:IType

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

toByteType back to summary

public IType toByteType(IType type)

Converts the given IType, if it's the primitive byte, into the Byte type.

Parameters

type:IType: The IType to possibly convert

Returns:IType

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

toDoubleType back to summary

public IType toDoubleType(IType type)

Converts the given IType, if it's the primitive double, into the Double type.

Parameters

type:IType: The IType to possibly convert

Returns:IType

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

toFloatType back to summary

public IType toFloatType(IType type)

Converts the given IType, if it's the primitive float, into the Float type.

Parameters

type:IType: The IType to possibly convert

Returns:IType

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

toIntegerType back to summary

public IType toIntegerType(IType type)

Converts the given IType, if it's the primitive int, into the Integer type.

Parameters

type:IType: The IType to possibly convert

Returns:IType

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

toShortType back to summary

public IType toShortType(IType type)

Converts the given IType, if it's the primitive short, into the Short type.

Parameters

type:IType: The IType to possibly convert

Returns:IType

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

unknownType back to summary

public IType unknownType()

Retrieves the IType that represents an unknown type.

Returns:IType: The external form of an unknown type

unknownTypeDeclaration back to summary

public ITypeDeclaration unknownTypeDeclaration()

Returns the ITypeDeclaration for the IType representing an unknown type.

Returns:ITypeDeclaration: The ITypeDeclaration of the unknown type

public final Class TypeHelper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail