org.apache.flex.compiler.definitions.references

Class ReferenceFactory

java.lang.Object

org.apache.flex.compiler.definitions.references.ReferenceFactory

public class ReferenceFactory
extends Object

A factory class to create instances of type IReference.

Method Summary

Methods

Modifier and Type	Method and Description
static IReference	builtinReference(IASLanguageConstants.BuiltinType type) Gets an IReference for one of the builtin types such as Object, String, or Array.
static IReference	lexicalReference(IWorkspace workspace, String baseName) Generates an IReference for an unqualified base name.
static IResolvedQualifiersReference	multinameReference(IWorkspace workspace, Set<INamespaceDefinition> namespaces, String baseName) Generates an IReference for a multiname coming from an ABC.
static IReference	notATypeReference(IWorkspace workspace, String baseName) Generates an IReference for a type reference that will always be an error.
static IResolvedQualifiersReference	packageQualifiedReference(IWorkspace workspace, String qname) Generates an IReference for a fully qualified name.
static IResolvedQualifiersReference	packageQualifiedReference(IWorkspace workspace, String qname, boolean includeInternal) Generates an IReference for a fully qualified name.
static IResolvedQualifiersReference	packageQualifiedReference(IWorkspace workspace, String packageName, String baseName, boolean includeInternal) Generates an IReference for a base name qualified by a package name.
static IReference	parameterizedReference(IWorkspace workspace, IReference base, IReference param) Generates an IReference for a parameterized type, such as {@code Vector.
static IResolvedQualifiersReference	resolvedQualifierQualifiedReference(IWorkspace workspace, INamespaceDefinition namespace, String baseName) Generates an IReference for a base name qualified by an INamespaceDefinition.
static IReference	resolvedReference(IDefinition definition) Generates an IReference that always resolves to the IDefinition passed in.

Methods inherited from class java.lang.Object

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

Method Detail

builtinReference

public static IReference builtinReference(IASLanguageConstants.BuiltinType type)

Gets an IReference for one of the builtin types such as Object, String, or Array.

Parameters:

type - The IASLanguageConstants.BuiltinType you want the reference for.

Returns:

A BuiltinReference.

lexicalReference

public static IReference lexicalReference(IWorkspace workspace,
                          String baseName)

Generates an IReference for an unqualified base name.

Parameters:

workspace - The workspace.

baseName - The base name you want a reference to.

Returns:

A LexicalReference.

resolvedQualifierQualifiedReference

public static IResolvedQualifiersReference resolvedQualifierQualifiedReference(IWorkspace workspace,
                                                               INamespaceDefinition namespace,
                                                               String baseName)

Generates an IReference for a base name qualified by an INamespaceDefinition.

Parameters:

workspace - The workspace.

namespace - The INamespaceDefinition to use as the qualifier.

baseName - The base name you want to reference to.

Returns:

A ResolvedQualifiersReference.

packageQualifiedReference

public static IResolvedQualifiersReference packageQualifiedReference(IWorkspace workspace,
                                                     String packageName,
                                                     String baseName,
                                                     boolean includeInternal)

Generates an IReference for a base name qualified by a package name.

Parameters:

workspace - The workspace.

packageName - The package name to use as the qualifier.

baseName - The base name you want a reference to.

includeInternal - Indicates whether or not the reference should resolve to package internal definitions.

Returns:

A ResolvedQualifiersReference.

packageQualifiedReference

public static IResolvedQualifiersReference packageQualifiedReference(IWorkspace workspace,
                                                     String qname)

Generates an IReference for a fully qualified name.

It is expected that the string will be of the form my.package.name.Foo. This will be used to generate a reference to Foo in the package my.package.name.

Parameters:

workspace - The workspace.

qname - A String representing a fully qualified name.

Returns:

A ResolvedQualifiersReference.

packageQualifiedReference

public static IResolvedQualifiersReference packageQualifiedReference(IWorkspace workspace,
                                                     String qname,
                                                     boolean includeInternal)

Generates an IReference for a fully qualified name.

It is expected that the string will be of the form my.package.name.Foo. This will be used to generate a reference to Foo in the package my.package.name.

Parameters:

workspace - The workspace.

qname - A String representing a fully qualified name.

includeInternal - Indicates whether or not the reference should resolve to package internal definitions.

Returns:

A ResolvedQualifiersReference.

multinameReference

public static IResolvedQualifiersReference multinameReference(IWorkspace workspace,
                                              Set<INamespaceDefinition> namespaces,
                                              String baseName)

Generates an IReference for a multiname coming from an ABC.

Parameters:

workspace - The workspace.

namespaces - The set of INamespaceDefinitions to use as the namespace set.

baseName - The base name you want a reference to.

Returns:

A ResolvedQualifiersReference.n

parameterizedReference

public static IReference parameterizedReference(IWorkspace workspace,
                                IReference base,
                                IReference param)

Generates an IReference for a parameterized type, such as Vector.<Foo>.

This currently only supports one type parameter, as Vector is the only parameterized type, and it only takes 1 type parameter.

Parameters:

workspace - The workspace.

base - The base reference, such as Vector in Vector.<Foo>.

param - The type parameter reference, such as Foo in Vector.<Foo>.

Returns:

A ParameterizedReference.

resolvedReference

public static IReference resolvedReference(IDefinition definition)

Generates an IReference that always resolves to the IDefinition passed in.

This is useful for Vector methods, where the return type is the type parameter for the Vector (i.e., T in Vector.<T>).

Parameters:

definition - The IDefinition to generate a reference to.

Returns:

A ResolvedReference that resolves to d.

notATypeReference

public static IReference notATypeReference(IWorkspace workspace,
                           String baseName)

Generates an IReference for a type reference that will always be an error. An example would be: class C extends a.b.c.d.Foo{} If a.b.c.d was not a package name then this class would be used to represent the reference. This is because a property access will be an error, but we have to remember that something was specified for the base class so we can report the correct error when we try and resolve it.

Parameters:

workspace - The workspace.

baseName - The base name you want a reference to.

Returns:

A NotATypeReference.