ClassTraitsDefinition (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- org.apache.flex.compiler.internal.definitions.DefinitionBase
- - org.apache.flex.compiler.internal.definitions.ScopedDefinitionBase
  - - org.apache.flex.compiler.internal.definitions.MemberedDefinition
    - - org.apache.flex.compiler.internal.definitions.TypeDefinitionBase
      - org.apache.flex.compiler.internal.definitions.ClassTraitsDefinition

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, IMemberedDefinition, IScopedDefinition, ITypeDefinition, IDefinitionSet
```
public final class ClassTraitsDefinition
extends TypeDefinitionBase
```
Definition to represent the class traits, which holds all the static members, and whose baseclass is "Class". This is implemented as a wrapper around the existing TypeDefinition - most methods just proxy to the wrapped instance.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.definitions.TypeDefinitionBase
  TypeDefinitionBase.StaticTypeIterator, TypeDefinitionBase.TypeIterator

Field Summary
- Fields inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase
  FLAG_CAST_FUNCTION, FLAG_CONSTRUCTOR, FLAG_CONTINGENT, FLAG_DECLARED_IN_CONTROL_FLOW, FLAG_DEFAULT, FLAG_DEPRECATED, FLAG_DYNAMIC, FLAG_FINAL, FLAG_GENERATED_EMBED_CLASS, FLAG_HAS_INIT, FLAG_IMPLICIT, FLAG_NATIVE, FLAG_OVERRIDE, FLAG_REST, FLAG_STATIC, flags, nodeRef, singletonEmptyMetaTags

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getAbsoluteEnd()` Gets the absolute ending offset of the entire definition (not just the name).
`int`	`getAbsoluteStart()` Gets the absolute starting offset of the entire definition (not just the name).
`IMetaTag[]`	`getAllMetaTags()` Returns all the `IMetaTagNode` objects as an array
`String`	`getBaseName()` Gets the base (i.e., unqualified) name of this definition.
`int`	`getColumn()` Gets the local column number of the entire definition (not just the name).
`ASScope`	`getContainedScope()` Get the scope for this traits - will return the static scope so lookups in the returned scope will only find statics.
`String`	`getContainingFilePath()` Gets the file path in which this definition is defined.
`IASScope`	`getContainingScope()` Gets the scope in which this definition exists.
`String`	`getContainingSourceFilePath(ICompilerProject project)` Gets the source file path in which this definition is defined.
`int`	`getEnd()` Gets the local ending offset of this entire definition (not just the name).
`ASFileScope`	`getFileScope()`
`IFileSpecification`	`getFileSpecification()`
`int`	`getLine()` Gets the local line number of this entire definition (not just the name).
`protected String`	`getLocationString()`
`IMetaTag`	`getMetaTagByName(String name)` Returns the first `IMetaTagNode` matching the given name
`IMetaTag[]`	`getMetaTagsByName(String name)` Gets all the `IMetaTagNode` objects that match the given name
`Name`	`getMName(ICompilerProject project)` Codegen should never ask for the AET Name of a class traits
`ModifiersSet`	`getModifiers()`
`int`	`getNameColumn()` Get column number for the name of this definition, if it can be determined.
`int`	`getNameEnd()` Gets the local ending offset of the name of this definition.
`int`	`getNameLine()` Get line number for the name of this definition, if it can be determined.
`INamespaceReference`	`getNamespaceReference()` Gets the namespace that this definition belongs to.
`protected String`	`getNamespaceReferenceAsString()`
`int`	`getNameStart()` If the definition has metadata "__go_to_definition_help", use the annotated location.
`ITypeNode`	`getNode()` Returns the `IDefinitionNode` from which this definition was created, if the definition came from the AST for a source file.
`String`	`getPackageName()` Gets the fully-qualified package name for this definition.
`INamespaceDefinition`	`getProtectedNamespaceReference()` Gets the `INamespaceDefinition` that represents the protected namespace for this type.
`String`	`getQualifiedName()` Gets the fully-qualified name of this definition.
`String`	`getSourcePath()` Gets the local source path of the entire definition (not just the name).
`int`	`getStart()` Gets the local starting offset of the entire definition (not just the name).
`INamespaceDefinition`	`getStaticProtectedNamespaceReference()` Gets the `INamespaceDefinition` that represents the static protected namespace for this type.
`boolean`	`hasExplicitComment()` Determines if this node has an explicit comment.
`boolean`	`hasMetaTagByName(String name)` Determines if a specific `IMetaTagNode` exists in this collection
`boolean`	`hasModifier(ASModifier modifier)` Determines whether the specified modifier is present on this definition.
`boolean`	`hasNamespace(INamespaceReference namespace, ICompilerProject project)` Determines whether the specified namespace is present on this definition.
`boolean`	`isDynamic()` Class traits are never dynamic
`boolean`	`isFinal()` Is this definition marked as `final`?
`boolean`	`isInProject(ICompilerProject project)` Debugging method that can be used to assert that a definition is a specified project.
`boolean`	`isInstanceOf(ITypeDefinition type, ICompilerProject project)` isInstanceOf for the class traits - basically will return true if type is Class or Object
`boolean`	`isNative()` Is this definition marked as `native`?
`boolean`	`isOverride()` Is this definition marked as `override`?
`boolean`	`isStatic()` Is this definition marked as `static`?
`boolean`	`isTopLevelDefinition()` Is this definition a toplevel definition
`boolean`	`matches(DefinitionBase node)`
`Set<IInterfaceDefinition>`	`resolveAllInterfaces(ICompilerProject project)`
`IInterfaceDefinition[]`	`resolveInterfacesImpl(ICompilerProject project)` Resolve the interfaces that this definition extends (if an interface), or implements (if a class).

Methods inherited from class org.apache.flex.compiler.internal.definitions.TypeDefinitionBase
filterNullInterfaces, isInstanceOf, resolveType, staticTypeIterable, typeIteratable

Methods inherited from class org.apache.flex.compiler.internal.definitions.ScopedDefinitionBase
setContainedScope, verify

Methods inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase
addMetaTag, buildInnerString, buildString, getAncestorOfType, getArrayElementType, getBindableEventNames, getContainingASScope, getDefinition, getDeprecationInfo, getExplicitSourceComment, getInstanceType, getMaxSize, getParent, getPercentProxy, getSize, getSkinPart, getStorageName, getTypeAsDisplayString, getTypeDependencyType, getTypeReference, hasCollapseWhiteSpace, hasRichTextContent, inPackageNamespace, isBindable, isBindableStyle, isColor, isContingent, isContingentNeeded, isDeprecated, isEmpty, isGeneratedEmbedClass, isImplicit, isInternal, isPrivate, isProtected, isPublic, isRequiredSkinPart, resolveNamespace, resolveType, resolveType, resolveType, resolveType, setBindable, setContainingScope, setContingent, setDynamic, setFinal, setGeneratedEmbedClass, setImplicit, setLocation, setMetaTags, setModifier, setNameLocation, setNamespaceReference, setNative, setNode, setOverride, setPublic, setStatic, setTypeReference, toStorageName, toString, unsetOverride

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.flex.compiler.definitions.IDocumentableDefinition
getExplicitSourceComment

Methods inherited from interface org.apache.flex.compiler.definitions.IDefinition
getAncestorOfType, getBindableEventNames, getDeprecationInfo, getParent, getTypeAsDisplayString, getTypeReference, isBindable, isBindableStyle, isContingent, isContingentNeeded, isDeprecated, isGeneratedEmbedClass, isImplicit, isInternal, isPrivate, isProtected, isPublic, resolveNamespace

- Method Detail
  - getContainedScope
```
public ASScope getContainedScope()
```
    Get the scope for this traits - will return the static scope so lookups in the returned scope will only find statics.
    
    Specified by:
    
    getContainedScope in interface IScopedDefinition
    
    Overrides:
    
    getContainedScope in class ScopedDefinitionBase
    
    Returns:
    the scope within this IScopedDefinition
  - isDynamic
```
public boolean isDynamic()
```
    Class traits are never dynamic
    
    Specified by:
    
    isDynamic in interface IDefinition
    
    Overrides:
    
    isDynamic in class DefinitionBase
    
    Returns:
    true if the definition is dynamic.
  - getMName
```
public Name getMName(ICompilerProject project)
```
    Codegen should never ask for the AET Name of a class traits
    
    Overrides:
    
    getMName in class DefinitionBase
    
    Parameters:
    project - the Project to use when resolving the Definitions Namespace
    
    Returns:
    An AET Name object that represents the qualified name of this definition. Will return null if errors are encountered while constructing the name (such as, the Namespace of the Definition is unresolved).
  - isInstanceOf
```
public boolean isInstanceOf(ITypeDefinition type,
                   ICompilerProject project)
```
    isInstanceOf for the class traits - basically will return true if type is Class or Object
    
    Parameters:
    type - An ITypeDefinition representing a class or interface.
    project - The ICompilerProject within which references should be resolved
    
    Returns:
    A flag indicating whether an "is-a" relationship exists between the two types.
  - matches
```
public boolean matches(DefinitionBase node)
```
    Overrides:
    
    matches in class DefinitionBase
  - getNode
```
public ITypeNode getNode()
```
    Description copied from interface: IDefinition
    
    Returns the IDefinitionNode from which this definition was created, if the definition came from the AST for a source file.
    This method may require the AST to be reloaded or regenerated and therefore may be slow.
    More specific definition interfaces such as IClassDefinition redeclare this method to return a more specific node interface such as IClassNode.
    
    Specified by:
    
    getNode in interface IDefinition
    
    Specified by:
    
    getNode in interface ITypeDefinition
    
    Overrides:
    
    getNode in class TypeDefinitionBase
  - resolveAllInterfaces
```
public Set<IInterfaceDefinition> resolveAllInterfaces(ICompilerProject project)
```
  - getNameStart
```
public int getNameStart()
```
    Description copied from class: TypeDefinitionBase
    
    If the definition has metadata "__go_to_definition_help", use the annotated location. Otherwise, use the location information stored on the AST node.
    Gets the local starting offset of the name of this definition. It is zero-based.
    
    Specified by:
    
    getNameStart in interface IDefinition
    
    Overrides:
    
    getNameStart in class TypeDefinitionBase
    
    Returns:
    An int for the offset.
  - getPackageName
```
public String getPackageName()
```
    Description copied from interface: IDefinition
    
    Gets the fully-qualified package name for this definition.
    For example, the backage name of the class definition for the class flash.display.Sprite is "flash.display"
    
    Specified by:
    
    getPackageName in interface IDefinition
    
    Overrides:
    
    getPackageName in class TypeDefinitionBase
    
    Returns:
    The fully-qualified package name as a String.
  - resolveInterfacesImpl
```
public IInterfaceDefinition[] resolveInterfacesImpl(ICompilerProject project)
```
    Description copied from class: TypeDefinitionBase
    
    Resolve the interfaces that this definition extends (if an interface), or implements (if a class). This is the implementation method that the ASScopeCache can call when there is a cache miss. Other clients should use the resolveExtendedInterfaces/resolveImplementedInterfaces
    
    Specified by:
    
    resolveInterfacesImpl in class TypeDefinitionBase
    
    Parameters:
    project - the active project
    
    Returns:
    an Array of IInterfaceDefinition that this type extends, or implements.
  - getQualifiedName
```
public String getQualifiedName()
```
    Description copied from interface: IDefinition
    
    Gets the fully-qualified name of this definition.
    For example, the fully-qualified name of the class definition for the class flash.display.Sprite is "flash.display.Sprite".
    
    Specified by:
    
    getQualifiedName in interface IDefinition
    
    Overrides:
    
    getQualifiedName in class DefinitionBase
    
    Returns:
    The fully-qualified name as a String.
  - getFileSpecification
```
public IFileSpecification getFileSpecification()
```
    Overrides:
    
    getFileSpecification in class DefinitionBase
  - getSourcePath
```
public String getSourcePath()
```
    Description copied from interface: IDefinition
    
    Gets the local source path of the entire definition (not just the name). It is normalized.
    
    Specified by:
    
    getSourcePath in interface IDefinition
    
    Overrides:
    
    getSourcePath in class DefinitionBase
    
    Returns:
    An String for the path.
  getStart public int getStart() Description copied from interface: IDefinition Gets the local starting offset of the entire definition (not just the name). It is zero-based. Specified by: getStart in interface IDefinition Overrides: getStart in class DefinitionBase Returns: An int for the offset. getEnd public int getEnd() Description copied from interface: IDefinition Gets the local ending offset of this entire definition (not just the name). It is zero-based. Specified by: getEnd in interface IDefinition Overrides: getEnd in class DefinitionBase Returns: An int for the offset. getLine public int getLine() Description copied from interface: IDefinition Gets the local line number of this entire definition (not just the name). It is zero-based. Specified by: getLine in interface IDefinition Overrides: getLine in class DefinitionBase Returns: An int for the line number. getColumn public int getColumn() Description copied from interface: IDefinition Gets the local column number of the entire definition (not just the name). It is zero-based. Specified by: getColumn in interface IDefinition Overrides: getColumn in class DefinitionBase Returns: An int for the column number. getAbsoluteStart public int getAbsoluteStart() Description copied from interface: IDefinition Gets the absolute starting offset of the entire definition (not just the name). It is zero-based. Specified by: getAbsoluteStart in interface IDefinition Overrides: getAbsoluteStart in class DefinitionBase Returns: An int for the offset. getAbsoluteEnd public int getAbsoluteEnd() Description copied from interface: IDefinition Gets the absolute ending offset of the entire definition (not just the name). It is zero-based. Specified by: getAbsoluteEnd in interface IDefinition Overrides: getAbsoluteEnd in class DefinitionBase Returns: An int for the offset. getNameEnd public int getNameEnd() Description copied from interface: IDefinition Gets the local ending offset of the name of this definition. It is zero-based. Specified by: getNameEnd in interface IDefinition Overrides: getNameEnd in class DefinitionBase Returns: An int for the offset. getNameLine public int getNameLine() Description copied from class: DefinitionBase Get line number for the name of this definition, if it can be determined. Specified by: getNameLine in interface IDefinition Overrides: getNameLine in class DefinitionBase Returns: the line number, or -1 if we couldn't figure it out getNameColumn public int getNameColumn() Description copied from class: DefinitionBase Get column number for the name of this definition, if it can be determined. Specified by: getNameColumn in interface IDefinition Overrides: getNameColumn in class DefinitionBase Returns: the column number, or -1 if we couldn't figure it out getContainingFilePath public String getContainingFilePath() Description copied from interface: IDefinition Gets the file path in which this definition is defined. Specified by: getContainingFilePath in interface IDefinition Overrides: getContainingFilePath in class DefinitionBase Returns: A String for the file path. getContainingSourceFilePath public String getContainingSourceFilePath(ICompilerProject project) Description copied from interface: IDefinition Gets the source file path in which this definition is defined. For definitions from a source file (like *.as), the result is the same as IDefinition.getContainingFilePath(). If the definition is from a SWC library, and the library source path was set, the result is the file path in the source directory. If the source path was not set, the result is null. Specified by: getContainingSourceFilePath in interface IDefinition Overrides: getContainingSourceFilePath in class DefinitionBase Parameters: project - the containing project Returns: A String for the file path. isTopLevelDefinition public boolean isTopLevelDefinition() Description copied from class: DefinitionBase Is this definition a toplevel definition Overrides: isTopLevelDefinition in class DefinitionBase Returns: true if this definition is declared at file scope, or package scope. isFinal public boolean isFinal() Description copied from interface: IDefinition Is this definition marked as final? Specified by: isFinal in interface IDefinition Overrides: isFinal in class DefinitionBase Returns: true if the definition is final. isNative public boolean isNative() Description copied from interface: IDefinition Is this definition marked as native? Specified by: isNative in interface IDefinition Overrides: isNative in class DefinitionBase Returns: true if the definition is native. isOverride public boolean isOverride() Description copied from interface: IDefinition Is this definition marked as override? Specified by: isOverride in interface IDefinition Overrides: isOverride in class DefinitionBase Returns: true if the definition is override. isStatic public boolean isStatic() Description copied from interface: IDefinition Is this definition marked as static? Specified by: isStatic in interface IDefinition Overrides: isStatic in class DefinitionBase Returns: true if the definition is static. hasModifier public boolean hasModifier(ASModifier modifier) Description copied from interface: IDefinition Determines whether the specified modifier is present on this definition. See ASModifier for the list of modifiers. Specified by: hasModifier in interface IDefinition Overrides: hasModifier in class DefinitionBase Returns: true if the modifier is present. hasNamespace public boolean hasNamespace(INamespaceReference namespace, ICompilerProject project) Description copied from interface: IDefinition Determines whether the specified namespace is present on this definition. Namespaces include public, private, protected, and internal, plus any custom namespaces available in the definition's scope. The namespace is specified by an INamespaceReference, which can represent not only a custom namespace like ns1 but also ns1::ns2, (ns1::ns2)::ns3, etc. Specified by: hasNamespace in interface IDefinition Overrides: hasNamespace in class DefinitionBase Parameters: namespace - An INamespaceReference specifying the namespace to check for. Returns: true if the namespace is present. getNamespaceReference public INamespaceReference getNamespaceReference() Description copied from interface: IDefinition Gets the namespace that this definition belongs to. Specified by: getNamespaceReference in interface IDefinition Overrides: getNamespaceReference in class DefinitionBase Returns: An INamespaceReference representing the namespace. For some built-in namespaces, you can: == NamespaceDefinition.getPublic(), instanceof IPublicNamespaceDefinition, instanceof IProtectedNamespaceDefinition, or For a custom namespace, the INamespaceReference will represent an expression of the form ns1, ns1::ns2, (ns1::ns2)::ns3, etc. getAllMetaTags public IMetaTag[] getAllMetaTags() Description copied from interface: IDefinition Returns all the IMetaTagNode objects as an array Specified by: getAllMetaTags in interface IDefinition Overrides: getAllMetaTags in class DefinitionBase Returns: an array of objects, or an empty array getMetaTagsByName public IMetaTag[] getMetaTagsByName(String name) Description copied from interface: IDefinition Gets all the IMetaTagNode objects that match the given name Specified by: getMetaTagsByName in interface IDefinition Overrides: getMetaTagsByName in class DefinitionBase Parameters: name - the name to match, such as Event, Style, IconFile, etc Returns: an array of IMetaTagNode objects, or empty array (never null) hasMetaTagByName public boolean hasMetaTagByName(String name) Description copied from interface: IDefinition Determines if a specific IMetaTagNode exists in this collection Specified by: hasMetaTagByName in interface IDefinition Overrides: hasMetaTagByName in class DefinitionBase Parameters: name - the name of the tag Returns: true if it exists getMetaTagByName public IMetaTag getMetaTagByName(String name) Description copied from interface: IDefinition Returns the first IMetaTagNode matching the given name Specified by: getMetaTagByName in interface IDefinition Overrides: getMetaTagByName in class DefinitionBase Parameters: name - the name to search for Returns: an IMetaTagNode or null hasExplicitComment public boolean hasExplicitComment() Description copied from interface: IDocumentableDefinition Determines if this node has an explicit comment. Since comments can inherit, the value from getComment might not always be defined on the element itself Specified by: hasExplicitComment in interface IDocumentableDefinition Overrides: hasExplicitComment in class DefinitionBase Returns: true if we have an explicit comment getFileScope public ASFileScope getFileScope() Overrides: getFileScope in class DefinitionBase getModifiers public ModifiersSet getModifiers() Specified by: getModifiers in interface IDefinition Overrides: getModifiers in class DefinitionBase getBaseName public String getBaseName() Description copied from interface: IDefinition Gets the base (i.e., unqualified) name of this definition. For example, the base name of the class definition for the class flash.display.Sprite is "Sprite". Specified by: getBaseName in interface IDefinition Overrides: getBaseName in class DefinitionBase Returns: The base name as a String. getContainingScope public IASScope getContainingScope() Description copied from interface: IDefinition Gets the scope in which this definition exists. Specified by: getContainingScope in interface IDefinition Overrides: getContainingScope in class DefinitionBase Returns: An IASScope for the containing scope, or null if this definition has not yet been added to a scope. getProtectedNamespaceReference public INamespaceDefinition getProtectedNamespaceReference() Description copied from interface: ITypeDefinition Gets the INamespaceDefinition that represents the protected namespace for this type. Returns: The INamespaceDefinition that represents the protected namespace for this type. getStaticProtectedNamespaceReference public INamespaceDefinition getStaticProtectedNamespaceReference() Description copied from interface: ITypeDefinition Gets the INamespaceDefinition that represents the static protected namespace for this type. Returns: The INamespaceDefinition that represents the static protected namespace for this type. getLocationString protected String getLocationString() Overrides: getLocationString in class DefinitionBase getNamespaceReferenceAsString protected String getNamespaceReferenceAsString() Overrides: getNamespaceReferenceAsString in class DefinitionBase isInProject public boolean isInProject(ICompilerProject project) Description copied from interface: IDefinition Debugging method that can be used to assert that a definition is a specified project. Specified by: isInProject in interface IDefinition Overrides: isInProject in class DefinitionBase Returns: true if this definition is in the specified project.

Class ClassTraitsDefinition

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.definitions.TypeDefinitionBase

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

Method Summary

Methods inherited from class org.apache.flex.compiler.internal.definitions.TypeDefinitionBase

Methods inherited from class org.apache.flex.compiler.internal.definitions.ScopedDefinitionBase

Methods inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.flex.compiler.definitions.IDocumentableDefinition

Methods inherited from interface org.apache.flex.compiler.definitions.IDefinition

Method Detail

getContainedScope

isDynamic

getMName

isInstanceOf

matches

getNode

resolveAllInterfaces

getNameStart

getPackageName

resolveInterfacesImpl

getQualifiedName

getFileSpecification

getSourcePath

getStart

getEnd

getLine

getColumn

getAbsoluteStart

getAbsoluteEnd

getNameEnd

getNameLine

getNameColumn

getContainingFilePath

getContainingSourceFilePath

isTopLevelDefinition

isFinal

isNative

isOverride

isStatic

hasModifier

hasNamespace

getNamespaceReference

getAllMetaTags

getMetaTagsByName

hasMetaTagByName

getMetaTagByName

hasExplicitComment

getFileScope

getModifiers

getBaseName

getContainingScope

getProtectedNamespaceReference

getStaticProtectedNamespaceReference

getLocationString

getNamespaceReferenceAsString

isInProject