org.apache.royale.compiler.embedding

Interface IEmbedData

public interface IEmbedData

This is the main class which contains all information extracted from embed meta data.

Method Summary

Modifier and Type	Method and Description
boolean	addAttribute(ICompilerProject project, ISourceLocation location, String key, String value, Collection<ICompilerProblem> problems) Add an attribute
boolean	createTranscoder(ICompilerProject project, ISourceLocation location, Collection<ICompilerProblem> problems)
boolean	generatedClassExtendsAnother() Check if the generated class extends another
Object	getAttribute(EmbedAttribute attribute) Returns the value of an attribute.
EmbedAttribute[]	getAttributes()
String	getQName() Returns the qname of the class generated from the EmbedData.
ISWCFileEntry	getSWCSource()
ITranscoder	getTranscoder() Get the transcoder used by this embed.

Method Detail

addAttribute

boolean addAttribute(ICompilerProject project,
                     ISourceLocation location,
                     String key,
                     String value,
                     Collection<ICompilerProblem> problems)

Add an attribute

Parameters:

project - containing project

location - source location of the attribute

key - attribute key

value - attribute value

problems - any problems with the key or value

Returns:

true if there was an error

getAttribute

Object getAttribute(EmbedAttribute attribute)

Returns the value of an attribute.

Parameters:

attribute - An embed attribute.

Returns:

value of an attribute. null if attribute does not exist

getAttributes

EmbedAttribute[] getAttributes()

Returns:

All attributes

createTranscoder

boolean createTranscoder(ICompilerProject project,
                         ISourceLocation location,
                         Collection<ICompilerProblem> problems)

Parameters:

project - The compiler project.

location - The source location.

problems - The colleciton of compiler projects to which this method should add problems.

Returns:

true if the transcoder was successfully constructed

getQName

String getQName()

Returns the qname of the class generated from the EmbedData. The name is guaranteed to be unique and not conflict with user space names, unless a user defined class has been decorated with the embed metadata, in which case, the users class name will be returned.

Returns:

qname

generatedClassExtendsAnother

boolean generatedClassExtendsAnother()

Check if the generated class extends another

Returns:

true if another class is extended

getTranscoder

ITranscoder getTranscoder()

Get the transcoder used by this embed. This can be null if there was a problem with the Embed directive

Returns:

transcoder

getSWCSource

ISWCFileEntry getSWCSource()

Returns:

ISWCFileEntry entry to source asset contained within swc. null if not contained within SWC