public interface Report
Report
interface provides information about the composition
of an Application
or a Library
.Builder.getReport()
Modifier and Type | Field and Description |
---|---|
static Object |
COMPILER
Use this constant when querying information from the compiler.
|
static Object |
LINKER
Use this constant when querying information from the linker.
|
Modifier and Type | Method and Description |
---|---|
boolean |
contentUpdated()
Checks whether the sources, assets and libraries have been updated since the report was created.
|
String[] |
getAssetNames(int frame)
Gets the names of all the assets that are in the specified frame.
|
String[] |
getAssetNames(Object report)
Gets the names of all the assets that are involved in the
Application or Library . |
int |
getBackgroundColor()
Gets the background color.
|
String |
getCompilerVersion()
Outputs the compiler version.
|
int |
getDefaultHeight()
Gets the default height of the application.
|
int |
getDefaultWidth()
Gets the default width of the application.
|
String[] |
getDefinitionNames(int frame)
Gets the list of all the top-level, externally-visible definitions in the specified frame.
|
String[] |
getDefinitionNames(String sourceName)
Gets the list of all the top-level, externally-visible definitions in the specified
source file.
|
String[] |
getDependencies(String definition)
Gets the list of definitions that the specified definition depends on during run time.
|
int |
getFrameCount()
Gets the number of frames in the movie.
|
int |
getHeight()
Gets the user-defined height.
|
double |
getHeightPercent()
Gets the user-defined height percentage.
|
String[] |
getLibraryNames(Object report)
Gets the name of all the libraries that are involved in the
Application or Library . |
String |
getLocation(String definition)
Gets the location of the specified definition.
|
Message[] |
getMessages()
Reports the errors and warnings that were generated during the compilation.
|
String |
getPageTitle()
Gets the page title.
|
String[] |
getPrerequisites(String definition)
Gets the list of definitions that the specified definition depends on during initialization.
|
String[] |
getResourceBundleNames()
Gets the name of all the resource bundles that are involved in the Application/Library.
|
String[] |
getSourceNames(Object report)
Gets the name of all the sources that are involved in the
Application or Library . |
int |
getWidth()
Gets the user-defined width.
|
double |
getWidthPercent()
Gets the user-defined width percentage.
|
long |
writeConfigurationReport(Writer out)
Writes the configuration report to the specified output.
|
long |
writeLinkReport(Writer out)
Writes the linker report to the specified output.
|
long |
writeSizeReport(Writer out)
Writes the linker size report to the specified output.
|
static final Object COMPILER
static final Object LINKER
String[] getSourceNames(Object report)
Application
or Library
.
The getSourceNames(Report.COMPILER)
method returns the name of all the source files
that are involved in the compilation.
The getSourceNames(Report.LINKER)
method returns the name of all the source files
that are eventually output by the linker.
The getSourceNames(Report.COMPILER)
and getSourceNames(Report.LINKER)
methods can yield different results if the linker is
instructed to exclude certain definitions from the final output.
String[] getAssetNames(Object report)
Application
or Library
.
The getAssetNames(Report.COMPILER)
method returns the names of all the asset files
that are involved in the compilation.
The getAssetNames(Report.LINKER)
method returns the names of all the asset files
that are eventually output by the linker.
The getAssetNames(Report.COMPILER)
and getAssetNames(Report.LINKER)
methods can yield different results if the linker is
instructed to exclude certain definitions from the final output.
String[] getAssetNames(int frame)
getFrameCount()
.
If the compilation did not generate a movie, this method returns null
.
frame
- frame number. The number is 1-based.getFrameCount()
String[] getLibraryNames(Object report)
Application
or Library
.
The getLibraryNames(Report.COMPILER)
method returns the name of all the library files
that are involved in the compilation.
The getLibraryNames(Report.LINKER)
method returns the name of all the library files
that are eventually output by the linker.
The getLibraryNames(Report.COMPILER)
and getLibraryNames(Report.LINKER)
methods can yield different results if the linker is
instructed to exclude certain definitions from the final output.
String[] getResourceBundleNames()
getResourceBundleNames()
method returns a list of names that
can be passed to the Library.addResourceBundle()
method.
The returned value should match the output from the resource-bundle-list
compiler option.
String[] getDefinitionNames(String sourceName)
getSourceNames()
method.
The output definition names are in the QName format; for example: mx.controls:Button
.
sourceName
- Source file name.null
if there is no definition in the source file.String[] getDefinitionNames(int frame)
getFrameCount()
.
If the compilation did not generate a movie, this method returns null
.
frame
- frame number. The number is 1-based.getFrameCount()
String getLocation(String definition)
The specified definition name must be in the QName format; for example: mx.controls:Button
.
definition
- A definition is a class, function, variable, or namespace.null
if the definition is not found.String[] getPrerequisites(String definition)
The specified definition name must be in the QName format; for example: mx.controls:Button
.
definition
- A class.null
if there is no dependency.String[] getDependencies(String definition)
The specified definition name must be in the QName format; for example: mx.controls:Button
.
definition
- A definition is a class, function, variable, or namespace.null
if there is no dependency.long writeLinkReport(Writer out) throws IOException
Report
was generated before linking,
this method returns 0
. You should provide a BufferedWriter
, if possible.
You should be sure to close the specified Writer
.
To use this method, you must call the Configuration.keepLinkReport()
method
before the compilation.
out
- An instance of Writer
.IOException
- Thrown when an I/O error occurs while the link report is being written.Configuration.keepLinkReport(boolean)
long writeSizeReport(Writer out) throws IOException
Report
was generated before linking,
this method returns 0
. You should provide a BufferedWriter
, if possible.
You should be sure to close the specified Writer
.
To use this method, you must call the Configuration.keepSizeReport()
method
before the compilation.
out
- An instance of Writer
.IOException
- Thrown when an I/O error occurs while the link report is being written.Configuration.keepSizeReport(boolean)
long writeConfigurationReport(Writer out) throws IOException
BufferedWriter
, if possible.
Be sure to close the specified Writer
.
To use this method, you must call the Configuration.keepConfigurationReport()
method
before the compilation.
out
- An instance of Writer
.IOException
- Thrown when an I/O error occurs during writing the configuration report.Configuration.keepConfigurationReport(boolean)
int getBackgroundColor()
0x869CA7
.
If the Report
was generated before linking, this method returns 0
.String getPageTitle()
Report
was generated before linking, this method returns null
.null
if it was not specified.int getDefaultWidth()
500
.int getDefaultHeight()
375
.int getWidth()
Report
was generated before linking, this method returns 0
.0
if it was not specified.int getHeight()
Report
was generated before linking, this method returns 0
.0
if it was not specified.double getWidthPercent()
Report
was generated before linking, this method returns 0.0
.0.0
if it was not specified.double getHeightPercent()
Report
was generated before linking, this method returns 0.0
.0.0
if it was not specified.String getCompilerVersion()
Message[] getMessages()
Message
objects are errors and warnings.null
if there were no errors or warnings.int getFrameCount()
Application
, the returned
value is the number of frames in the movie. For Library
, the returned
value is the number of frames in library.swf.
If the compilation did not generate a movie, the returned value will be 0
.
boolean contentUpdated()
Copyright © 2016 The Apache Software Foundation. All rights reserved.