org.apache.royale.compiler.common

Enum DependencyType

java.lang.Object

java.lang.Enum<DependencyType>

org.apache.royale.compiler.common.DependencyType

All Implemented Interfaces:

Serializable, Comparable<DependencyType>

public enum DependencyType
extends Enum<DependencyType>

An enumeration representing the four types of dependencies that an edge in a DependencyGraph can have.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXPRESSION An EXPRESSION dependency is any dependency that isn't one of the other three types.
INHERITANCE An INHERITANCE dependency is created by a reference to a class or interface in the extends clause or the implements clause of a class or interface declaration.
NAMESPACE A NAMESPACE dependency is created by a reference to a user-defined namespace.
SIGNATURE A SIGNATURE dependency is created by a type annotation that is not inside of a function body.

Method Summary

Modifier and Type	Method and Description
boolean	existsIn(DependencyTypeSet dependencies) A helper function to check if this DependencyType is contained in an DependencyTypeSet.
static DependencyType	get(char symbol) Gets the enum object from its symbol.
char	getSymbol() Gets the character representing the dependency type in XML format (such as the <dep> tag in a SWC catalog).
static String	getTypeString(DependencyTypeSet types) Gets a short string of symbols for the dependency types in a dependency type set.
static DependencyType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DependencyType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INHERITANCE

public static final DependencyType INHERITANCE

An INHERITANCE dependency is created by a reference to a class or interface in the extends clause or the implements clause of a class or interface declaration.

Examples:

• class C2 extends C1 implements I1, I2
• interface I1 extends I2, I3

SIGNATURE

public static final DependencyType SIGNATURE

A SIGNATURE dependency is created by a type annotation that is not inside of a function body.

Examples:

• public var i:int
• private function f(i:int):String

NAMESPACE

public static final DependencyType NAMESPACE

A NAMESPACE dependency is created by a reference to a user-defined namespace.

Examples:

• ns var foo:int
• ns::foo
• use namespace ns

EXPRESSION

public static final DependencyType EXPRESSION

An EXPRESSION dependency is any dependency that isn't one of the other three types.

Method Detail

values

public static DependencyType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DependencyType c : DependencyType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DependencyType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getSymbol

public char getSymbol()

Gets the character representing the dependency type in XML format (such as the <dep> tag in a SWC catalog).

Returns:

symbol The character.

existsIn

public boolean existsIn(DependencyTypeSet dependencies)

A helper function to check if this DependencyType is contained in an DependencyTypeSet.

Parameters:

dependencies - A DependencyTypeSet to look in.

Returns:

true if this DependencyType is contained in the specified DependencyTypeSet.

get

public static DependencyType get(char symbol)

Gets the enum object from its symbol.

Parameters:

symbol - The character representing the dependency type in XML format (such as the <dep> tag in a SWC catalog), such as 'i'.

Returns:

The enum object with the specified symbol, such as INHERITANCE.

getTypeString

public static String getTypeString(DependencyTypeSet types)

Gets a short string of symbols for the dependency types in a dependency type set.

Parameters:

types - A DependencyTypeSet.

Returns:

A short string of symbols of the types in the DependencyTypeSet in INHERITANCE, NAMESPACE, SIGNATURE, EXPRESSION order.