org.apache.flex.compiler.internal.definitions

Class MetadataDefinitionBase

java.lang.Object

org.apache.flex.compiler.internal.definitions.DefinitionBase

org.apache.flex.compiler.internal.definitions.MetadataDefinitionBase

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, IMetadataDefinition, IDefinitionSet

Direct Known Subclasses:

EffectDefinition, EventDefinition, StyleDefinition

public abstract class MetadataDefinitionBase
extends DefinitionBase
implements IMetadataDefinition

This is the abstract base class for definitions in the symbol table that that are declared by metadata tags on other definitions.

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

Constructor Summary

Constructors

Constructor and Description
MetadataDefinitionBase(String name, String tagName, IClassDefinition decoratedDefinition)

Method Summary

Methods

Modifier and Type	Method and Description
IMetaTagAttribute[]	getAttributes()
String	getAttributeValue(String key)
IDefinition	getDecoratedDefinition() Gets the definition that this metadata is decorating.
IDefinitionNode	getDecoratedDefinitionNode()
String	getDeprecatedMessage() Gets the value of the deprecatedMessage attribute.
String	getDeprecatedReplacement() Gets the value of the deprecatedReplacement attribute.
String	getDeprecatedSince() Gets the value of the deprecatedSince attribute.
int	getEnd() Gets the local ending offset of this entire definition (not just the name).
int	getStart() Gets the local starting offset of the entire definition (not just the name).
String	getTagName()
IMetaTagsNode	getTagNode()
boolean	matches(DefinitionBase definition)

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

addMetaTag, buildInnerString, buildString, getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getArrayElementType, getBaseName, getBindableEventNames, getColumn, getContainingASScope, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDefinition, getDeprecationInfo, getExplicitSourceComment, getFileScope, getFileSpecification, getInstanceType, getLine, getLocationString, getMaxSize, getMetaTagByName, getMetaTagsByName, getMName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNamespaceReferenceAsString, getNameStart, getNode, getPackageName, getParent, getPercentProxy, getQualifiedName, getSize, getSkinPart, getSourcePath, getStorageName, getTypeAsDisplayString, getTypeDependencyType, getTypeReference, hasCollapseWhiteSpace, hasExplicitComment, hasMetaTagByName, hasModifier, hasNamespace, hasRichTextContent, inPackageNamespace, isBindable, isBindableStyle, isColor, isContingent, isContingentNeeded, isDeprecated, isDynamic, isEmpty, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isRequiredSkinPart, isStatic, isTopLevelDefinition, resolveNamespace, resolveType, 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, verify

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, hasExplicitComment

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

getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getBaseName, getBindableEventNames, getColumn, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDeprecationInfo, getLine, getMetaTagByName, getMetaTagsByName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNameStart, getNode, getPackageName, getParent, getQualifiedName, getSourcePath, getTypeAsDisplayString, getTypeReference, hasMetaTagByName, hasModifier, hasNamespace, isBindable, isBindableStyle, isContingent, isContingentNeeded, isDeprecated, isDynamic, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isStatic, resolveNamespace, resolveType

Constructor Detail

MetadataDefinitionBase

public MetadataDefinitionBase(String name,
                      String tagName,
                      IClassDefinition decoratedDefinition)

Method Detail

getDecoratedDefinition

public IDefinition getDecoratedDefinition()

Description copied from interface: IMetadataDefinition

Gets the definition that this metadata is decorating.

Specified by:

getDecoratedDefinition in interface IMetadataDefinition

Returns:

An IDefinition object.

getTagNode

public IMetaTagsNode getTagNode()

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.

getDecoratedDefinitionNode

public IDefinitionNode getDecoratedDefinitionNode()

getTagName

public String getTagName()

getAttributes

public IMetaTagAttribute[] getAttributes()

getAttributeValue

public String getAttributeValue(String key)

matches

public boolean matches(DefinitionBase definition)

Overrides:

matches in class DefinitionBase

getDeprecatedSince

public String getDeprecatedSince()

Description copied from interface: IMetadataDefinition

Gets the value of the deprecatedSince attribute.

Specified by:

getDeprecatedSince in interface IMetadataDefinition

Returns:

The attribute value as a String, or null if there is no such attribute.

getDeprecatedReplacement

public String getDeprecatedReplacement()

Description copied from interface: IMetadataDefinition

Gets the value of the deprecatedReplacement attribute.

Specified by:

getDeprecatedReplacement in interface IMetadataDefinition

Returns:

The attribute value as a String, or null if there is no such attribute.

getDeprecatedMessage

public String getDeprecatedMessage()

Description copied from interface: IMetadataDefinition

Gets the value of the deprecatedMessage attribute.

Specified by:

getDeprecatedMessage in interface IMetadataDefinition

Returns:

The attribute value as a String, or null if there is no such attribute.