com.google.gwt.dev.javac.typemodel

Class TypeOracle

java.lang.Object

com.google.gwt.core.ext.typeinfo.TypeOracle

com.google.gwt.dev.javac.typemodel.TypeOracle

Direct Known Subclasses:

LibraryTypeOracle

public class TypeOracle
extends TypeOracle

Provides type-related information about a set of types.

All type objects exposed, such as JClassType and others, have a stable identity relative to this type oracle instance. Consequently, you can reliably compare object identity of any objects this type oracle produces. For example, the following code relies on this stable identity guarantee:

 JClassType o = typeOracle.getJavaLangObject();
 JClassType s1 = typeOracle.getType("java.lang.String");
 JClassType s2 = typeOracle.getType("java.lang.String");
 assert (s1 == s2);
 assert (o == s1.getSuperclass());
 JParameterizedType ls = typeOracle.parse("java.util.List<java.lang.String>");
 assert (ls.getTypeArgs()[0] == s1);
 

Field Summary

Fields inherited from class com.google.gwt.core.ext.typeinfo.TypeOracle

TAG_TYPEARGS

Constructor Summary

Constructors

Constructor and Description
TypeOracle()

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewType(JRealClassType newType)
void	ensureAllLoaded() Make sure that all possible Types have been read and made available for querying.
JPackage	findPackage(String pkgName) Attempts to find a package by name.
JClassType	findType(String name) Finds a type (even nested ones) given its fully-qualified name.
JClassType	findType(String pkgName, String typeName) Finds a type (even nested ones) given its package-relative name.
JArrayType	getArrayType(JType componentType) Gets the type object that represents an array of the specified type.
Set<? extends JClassType>	getDualJsoImplInterfaces() Returns an unmodifiable, live view of all interface types that are implemented by both a JSO subtype and at least one Object subtype.
JClassType	getJavaLangObject() Gets a reference to the type object representing java.lang.Object.
JClassType	getJavaScriptObject() Gets a reference to the type object representing com.google.gwt.core.client.JavaScriptObject.
JPackage	getOrCreatePackage(String name) Ensure that a package with the specified name exists as well as its parent packages.
JPackage	getPackage(String pkgName) Gets a package by name.
JPackage[]	getPackages() Gets an array of all packages known to this type oracle.
JParameterizedType	getParameterizedType(JGenericType genericType, JClassType[] typeArgs) Gets the parameterized type object that represents the combination of a specified raw type and a set of type arguments.
JParameterizedType	getParameterizedType(JGenericType extGenericType, JClassType extEnclosingType, JClassType[] extTypeArgs) Gets the parameterized type object that represents the combination of a specified raw type and a set of type arguments.
long	getReloadCount() Deprecated. This method will always return 0 because a TypeOracle never gets reloaded anymore. Callers should not rely on this value to manage static state.
JClassType	getSingleJsoImpl(JClassType intf) Returns the single implementation type for an interface returned via getSingleJsoImplInterfaces() or null if no JSO implementation is defined.
Set<? extends JClassType>	getSingleJsoImplInterfaces() Returns an unmodifiable, live view of all interface types that are implemented by exactly one JSO subtype.
JClassType	getType(String name) Finds a type given its fully qualified name.
JClassType	getType(String pkgName, String topLevelTypeSimpleName) Finds a type given its package-relative name.
JClassType[]	getTypes() Gets all types, both top-level and nested.
JWildcardType	getWildcardType(JWildcardType.BoundType boundType, JClassType extTypeBound)
JType	parse(String type) Parses the string form of a type to produce the corresponding type object.
static void	sort(JClassType[] types) Convenience method to sort class types in a consistent way.
static void	sort(JConstructor[] ctors) Convenience method to sort constructors in a consistent way.
static void	sort(JField[] fields) Convenience method to sort fields in a consistent way.
static void	sort(JMethod[] methods) Convenience method to sort methods in a consistent way.

Methods inherited from class com.google.gwt.core.ext.typeinfo.TypeOracle

sort, sort, sort, sort

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TypeOracle

public TypeOracle()

Method Detail

sort

public static void sort(JClassType[] types)

Convenience method to sort class types in a consistent way. Note that the order is subject to change and is intended to generate an "aesthetically pleasing" order rather than a computationally reliable order.

sort

public static void sort(JConstructor[] ctors)

Convenience method to sort constructors in a consistent way. Note that the order is subject to change and is intended to generate an "aesthetically pleasing" order rather than a computationally reliable order.

sort

public static void sort(JField[] fields)

Convenience method to sort fields in a consistent way. Note that the order is subject to change and is intended to generate an "aesthetically pleasing" order rather than a computationally reliable order.

sort

public static void sort(JMethod[] methods)

Convenience method to sort methods in a consistent way. Note that the order is subject to change and is intended to generate an "aesthetically pleasing" order rather than a computationally reliable order.

ensureAllLoaded

public void ensureAllLoaded()

Make sure that all possible Types have been read and made available for querying. Some TypeOracle implementations may choose to load only a part of the world when executing within a non-global phase of a library compile but may need to be pushed toward having global knowledge in some circumstances.

findPackage

public JPackage findPackage(String pkgName)

Attempts to find a package by name. All requests for the same package return the same package object.

Specified by:

findPackage in class TypeOracle

Returns:

null if the package could not be found

findType

public JClassType findType(String name)

Finds a type (even nested ones) given its fully-qualified name.

Specified by:

findType in class TypeOracle

Parameters:

name - fully-qualified class/interface name - for nested classes, use its source name rather than its binary name (that is, use a "." rather than a "$")

Returns:

null if the type is not found

findType

public JClassType findType(String pkgName,
                  String typeName)

Finds a type (even nested ones) given its package-relative name. For nested classes, use its source name rather than its binary name (that is, use a "." rather than a "$").

Specified by:

findType in class TypeOracle

Returns:

null if the type is not found

getArrayType

public JArrayType getArrayType(JType componentType)

Gets the type object that represents an array of the specified type. The returned type always has a stable identity so as to guarantee that all calls to this method with the same argument return the same object.

Specified by:

getArrayType in class TypeOracle

Parameters:

componentType - the component type of the array, which can itself be an array type

Returns:

a type object representing an array of the component type

getJavaLangObject

public JClassType getJavaLangObject()

Gets a reference to the type object representing java.lang.Object.

Specified by:

getJavaLangObject in class TypeOracle

getJavaScriptObject

public JClassType getJavaScriptObject()

Gets a reference to the type object representing com.google.gwt.core.client.JavaScriptObject.

getOrCreatePackage

public JPackage getOrCreatePackage(String name)

Ensure that a package with the specified name exists as well as its parent packages.

Specified by:

getOrCreatePackage in class TypeOracle

getPackage

public JPackage getPackage(String pkgName)
                    throws NotFoundException

Gets a package by name. All requests for the same package return the same package object.

Specified by:

getPackage in class TypeOracle

Returns:

the package object associated with the specified name

Throws:

NotFoundException - if getOrCreatePackage hasn't been called for this package or any child packages

getPackages

public JPackage[] getPackages()

Gets an array of all packages known to this type oracle.

Specified by:

getPackages in class TypeOracle

Returns:

an array of packages, possibly of zero-length

getParameterizedType

public JParameterizedType getParameterizedType(JGenericType extGenericType,
                                      JClassType extEnclosingType,
                                      JClassType[] extTypeArgs)

Gets the parameterized type object that represents the combination of a specified raw type and a set of type arguments. The returned type always has a stable identity so as to guarantee that all calls to this method with the same arguments return the same object.

Specified by:

getParameterizedType in class TypeOracle

Parameters:

extGenericType - a generic base class

extEnclosingType -

extTypeArgs - the type arguments bound to the specified generic type

Returns:

a type object representing this particular binding of type arguments to the specified generic

Throws:

IllegalArgumentException - if the parameterization of a non-static member type does not specify an enclosing type or if not enough arguments were specified to parameterize the generic type

NullPointerException - if genericType is null

getParameterizedType

public JParameterizedType getParameterizedType(JGenericType genericType,
                                      JClassType[] typeArgs)

Gets the parameterized type object that represents the combination of a specified raw type and a set of type arguments. The returned type always has a stable identity so as to guarantee that all calls to this method with the same arguments return the same object.

Specified by:

getParameterizedType in class TypeOracle

Parameters:

genericType - a generic base class

typeArgs - the type arguments bound to the specified generic type

Returns:

a type object representing this particular binding of type arguments to the specified generic

Throws:

IllegalArgumentException - if the generic type is a non-static member type or if not enough arguments were specified to parameterize the generic type

NullPointerException - if genericType is null

getReloadCount

@Deprecated
public long getReloadCount()

Deprecated. This method will always return 0 because a TypeOracle never gets reloaded anymore. Callers should not rely on this value to manage static state.

Specified by:

getReloadCount in class TypeOracle

getSingleJsoImpl

public JClassType getSingleJsoImpl(JClassType intf)

Returns the single implementation type for an interface returned via getSingleJsoImplInterfaces() or null if no JSO implementation is defined.

Specified by:

getSingleJsoImpl in class TypeOracle

getSingleJsoImplInterfaces

public Set<? extends JClassType> getSingleJsoImplInterfaces()

Returns an unmodifiable, live view of all interface types that are implemented by exactly one JSO subtype.

Specified by:

getSingleJsoImplInterfaces in class TypeOracle

getDualJsoImplInterfaces

public Set<? extends JClassType> getDualJsoImplInterfaces()

Returns an unmodifiable, live view of all interface types that are implemented by both a JSO subtype and at least one Object subtype.

getType

public JClassType getType(String name)
                   throws NotFoundException

Finds a type given its fully qualified name. For nested classes, use its source name rather than its binary name (that is, use a "." rather than a "$").

Specified by:

getType in class TypeOracle

Returns:

the specified type

Throws:

NotFoundException

getType

public JClassType getType(String pkgName,
                 String topLevelTypeSimpleName)
                   throws NotFoundException

Finds a type given its package-relative name. For nested classes, use its source name rather than its binary name (that is, use a "." rather than a "$").

Specified by:

getType in class TypeOracle

Returns:

the specified type

Throws:

NotFoundException

getTypes

public JClassType[] getTypes()

Gets all types, both top-level and nested.

Specified by:

getTypes in class TypeOracle

Returns:

an array of types, possibly of zero length

getWildcardType

public JWildcardType getWildcardType(JWildcardType.BoundType boundType,
                            JClassType extTypeBound)

Specified by:

getWildcardType in class TypeOracle

parse

public JType parse(String type)
            throws TypeOracleException

Parses the string form of a type to produce the corresponding type object. The types that can be parsed include primitives, class and interface names, simple parameterized types (those without wildcards or bounds), and arrays of the preceding.

Examples of types that can be parsed by this method.

• int
• java.lang.Object
• java.lang.String[]
• char[][]
• void
• List<Shape>
• List<List<Shape>>

Specified by:

parse in class TypeOracle

Parameters:

type - a type signature to be parsed

Returns:

the type object corresponding to the parse type

Throws:

TypeOracleException

addNewType

public void addNewType(JRealClassType newType)