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

java.lang.Object
- flex2.tools.oem.internal.OEMReport

All Implemented Interfaces:

Report
```
public class OEMReport
extends Object
implements Report
```
A Report implementation.

Version:

2.0.1

Author:

Clement Wong

Field Summary
- Fields inherited from interface flex2.tools.oem.Report
  COMPILER, LINKER

Constructor Summary

Constructors
Constructor and Description
`OEMReport(List<Source> sources, SimpleMovie movie, Configuration configuration, SourceList sourceList, String configurationReport, List<Message> messages)`
`OEMReport(List<Source> sources, SimpleMovie movie, Configuration configuration, SourceList sourceList, String configurationReport, List<Message> messages, Map<String,VirtualFile> archiveFiles)`

Method Summary

Methods
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.

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

- Constructor Detail
  - OEMReport
```
public OEMReport(List<Source> sources,
         SimpleMovie movie,
         Configuration configuration,
         SourceList sourceList,
         String configurationReport,
         List<Message> messages)
```
  - OEMReport
```
public OEMReport(List<Source> sources,
         SimpleMovie movie,
         Configuration configuration,
         SourceList sourceList,
         String configurationReport,
         List<Message> messages,
         Map<String,VirtualFile> archiveFiles)
```
- Method Detail
  - contentUpdated
```
public boolean contentUpdated()
```
    Description copied from interface: Report
    
    Checks whether the sources, assets and libraries have been updated since the report was created.
    
    Specified by:
    
    contentUpdated in interface Report
    
    Returns:
  - getSourceNames
```
public String[] getSourceNames(Object report)
```
    Description copied from interface: Report
    
    Gets the name of all the sources that are involved in the 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.
    
    Specified by:
    
    getSourceNames in interface Report
    
    Parameters:
    report - The COMPILER or LINKER.
    
    Returns:
    A list of source names.
    See Also:
    Report.COMPILER, Report.LINKER
  - getAssetNames
```
public String[] getAssetNames(int frame)
```
    Description copied from interface: Report
    
    Gets the names of all the assets that are in the specified frame. The number of frames in the movie can be obtained by invoking getFrameCount().
    If the compilation did not generate a movie, this method returns null.
    
    Specified by:
    
    getAssetNames in interface Report
    
    Parameters:
    frame - frame number. The number is 1-based.
    
    Returns:
    an array of asset file names
    See Also:
    Report.getFrameCount()
  - getAssetNames
```
public String[] getAssetNames(Object report)
```
    Description copied from interface: Report
    
    Gets the names of all the assets that are involved in the 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.
    
    Specified by:
    
    getAssetNames in interface Report
    
    Parameters:
    report - The COMPILER or LINKER.
    
    Returns:
    A list of asset names.
    See Also:
    Report.COMPILER, Report.LINKER
  - getLibraryNames
```
public String[] getLibraryNames(Object report)
```
    Description copied from interface: Report
    
    Gets the name of all the libraries that are involved in the 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.
    
    Specified by:
    
    getLibraryNames in interface Report
    
    Parameters:
    report - The COMPILER or LINKER.
    
    Returns:
    A list of library names.
    See Also:
    Report.COMPILER, Report.LINKER
  - getResourceBundleNames
```
public String[] getResourceBundleNames()
```
    Description copied from interface: Report
    
    Gets the name of all the resource bundles that are involved in the Application/Library. The 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.
    
    Specified by:
    
    getResourceBundleNames in interface Report
    
    Returns:
    A list of resource bundle names.
  - getDefinitionNames
```
public String[] getDefinitionNames(int frame)
```
    Description copied from interface: Report
    
    Gets the list of all the top-level, externally-visible definitions in the specified frame. The sequence represents the order in which the definitions are exported to the frame. The number of frames in the movie can be obtained by invoking getFrameCount().
    If the compilation did not generate a movie, this method returns null.
    
    Specified by:
    
    getDefinitionNames in interface Report
    
    Parameters:
    frame - frame number. The number is 1-based.
    
    Returns:
    an array of definition names
    See Also:
    Report.getFrameCount()
  - getDefinitionNames
```
public String[] getDefinitionNames(String sourceName)
```
    Description copied from interface: Report
    
    Gets the list of all the top-level, externally-visible definitions in the specified source file. You can get the specified source file from the getSourceNames() method.
    The output definition names are in the QName format; for example: mx.controls:Button.
    
    Specified by:
    
    getDefinitionNames in interface Report
    
    Parameters:
    sourceName - Source file name.
    
    Returns:
    An array of definition names; null if there is no definition in the source file.
  - getLocation
```
public String getLocation(String definition)
```
    Description copied from interface: Report
    
    Gets the location of the specified definition.
    The specified definition name must be in the QName format; for example: mx.controls:Button.
    
    Specified by:
    
    getLocation in interface Report
    
    Parameters:
    definition - A definition is a class, function, variable, or namespace.
    
    Returns:
    The location of the specified definition; null if the definition is not found.
  - getDependencies
```
public String[] getDependencies(String definition)
```
    Description copied from interface: Report
    
    Gets the list of definitions that the specified definition depends on during run time.
    The specified definition name must be in the QName format; for example: mx.controls:Button.
    
    Specified by:
    
    getDependencies in interface Report
    
    Parameters:
    definition - A definition is a class, function, variable, or namespace.
    
    Returns:
    An array of definition names; null if there is no dependency.
  - getPrerequisites
```
public String[] getPrerequisites(String definition)
```
    Description copied from interface: Report
    
    Gets the list of definitions that the specified definition depends on during initialization.
    The specified definition name must be in the QName format; for example: mx.controls:Button.
    
    Specified by:
    
    getPrerequisites in interface Report
    
    Parameters:
    definition - A class.
    
    Returns:
    An array of definition names; null if there is no dependency.
  - writeLinkReport
```
public long writeLinkReport(Writer out)
                     throws IOException
```
    Description copied from interface: Report
    
    Writes the linker report to the specified output. If this 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.
    
    Specified by:
    
    writeLinkReport in interface Report
    
    Parameters:
    out - An instance of Writer.
    
    Returns:
    The number of characters written out.
    
    Throws:
    
    IOException - Thrown when an I/O error occurs while the link report is being written.
    See Also:
    Configuration.keepLinkReport(boolean)
  - writeSizeReport
```
public long writeSizeReport(Writer out)
                     throws IOException
```
    Description copied from interface: Report
    
    Writes the linker size report to the specified output. If this 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.
    
    Specified by:
    
    writeSizeReport in interface Report
    
    Parameters:
    out - An instance of Writer.
    
    Returns:
    The number of characters written out.
    
    Throws:
    
    IOException - Thrown when an I/O error occurs while the link report is being written.
    See Also:
    Configuration.keepSizeReport(boolean)
  - writeConfigurationReport
```
public long writeConfigurationReport(Writer out)
                              throws IOException
```
    Description copied from interface: Report
    
    Writes the configuration report to the specified output. You should provide a BufferedWriter, if possible. Be sure to close the specified Writer.
    To use this method, you must call the Configuration.keepConfigurationReport() method before the compilation.
    
    Specified by:
    
    writeConfigurationReport in interface Report
    
    Parameters:
    out - An instance of Writer.
    
    Returns:
    The number of characters written out.
    
    Throws:
    
    IOException - Thrown when an I/O error occurs during writing the configuration report.
    See Also:
    Configuration.keepConfigurationReport(boolean)
  - getBackgroundColor
```
public int getBackgroundColor()
```
    Description copied from interface: Report
    
    Gets the background color. The default value is 0x869CA7. If the Report was generated before linking, this method returns 0.
    
    Specified by:
    
    getBackgroundColor in interface Report
    
    Returns:
    An RGB value.
  - getPageTitle
```
public String getPageTitle()
```
    Description copied from interface: Report
    
    Gets the page title. If the Report was generated before linking, this method returns null.
    
    Specified by:
    
    getPageTitle in interface Report
    
    Returns:
    Page title; null if it was not specified.
  - getDefaultWidth
```
public int getDefaultWidth()
```
    Description copied from interface: Report
    
    Gets the default width of the application. The default value is 500.
    
    Specified by:
    
    getDefaultWidth in interface Report
    
    Returns:
    The default width, in pixels.
  - getDefaultHeight
```
public int getDefaultHeight()
```
    Description copied from interface: Report
    
    Gets the default height of the application. The default value is 375.
    
    Specified by:
    
    getDefaultHeight in interface Report
    
    Returns:
    The default height, in pixels.
  - getWidth
```
public int getWidth()
```
    Description copied from interface: Report
    
    Gets the user-defined width. If the Report was generated before linking, this method returns 0.
    
    Specified by:
    
    getWidth in interface Report
    
    Returns:
    Width of the application, in pixels; 0 if it was not specified.
  - getHeight
```
public int getHeight()
```
    Description copied from interface: Report
    
    Gets the user-defined height. If the Report was generated before linking, this method returns 0.
    
    Specified by:
    
    getHeight in interface Report
    
    Returns:
    Height, in pixels; 0 if it was not specified.
  - getWidthPercent
```
public double getWidthPercent()
```
    Description copied from interface: Report
    
    Gets the user-defined width percentage. If the Report was generated before linking, this method returns 0.0.
    
    Specified by:
    
    getWidthPercent in interface Report
    
    Returns:
    Width percentage; 0.0 if it was not specified.
  - getHeightPercent
```
public double getHeightPercent()
```
    Description copied from interface: Report
    
    Gets the user-defined height percentage. If the Report was generated before linking, this method returns 0.0.
    
    Specified by:
    
    getHeightPercent in interface Report
    
    Returns:
    Height percentage; 0.0 if it was not specified.
  - getCompilerVersion
```
public String getCompilerVersion()
```
    Description copied from interface: Report
    
    Outputs the compiler version.
    
    Specified by:
    
    getCompilerVersion in interface Report
    
    Returns:
    A string representing the compiler version.
  - getMessages
```
public Message[] getMessages()
```
    Description copied from interface: Report
    
    Reports the errors and warnings that were generated during the compilation. The returned Message objects are errors and warnings.
    
    Specified by:
    
    getMessages in interface Report
    
    Returns:
    An array of error and warning Message objects; null if there were no errors or warnings.
  - getFrameCount
```
public int getFrameCount()
```
    Description copied from interface: Report
    
    Gets the number of frames in the movie. For 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.
    
    Specified by:
    
    getFrameCount in interface Report
    
    Returns:
    number of frames

Class OEMReport

Field Summary

Fields inherited from interface flex2.tools.oem.Report

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OEMReport

OEMReport

Method Detail

contentUpdated

getSourceNames

getAssetNames

getAssetNames

getLibraryNames

getResourceBundleNames

getDefinitionNames

getDefinitionNames

getLocation

getDependencies

getPrerequisites

writeLinkReport

writeSizeReport

writeConfigurationReport

getBackgroundColor

getPageTitle

getDefaultWidth

getDefaultHeight

getWidth

getHeight

getWidthPercent

getHeightPercent

getCompilerVersion

getMessages

getFrameCount