net.flexmojos.oss.plugin.compiler

Class AsdocMojo

java.lang.Object

net.flexmojos.oss.plugin.AbstractMavenMojo

net.flexmojos.oss.plugin.compiler.AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

net.flexmojos.oss.plugin.compiler.AsdocMojo

All Implemented Interfaces:

Cloneable, FlexMojo, IASDocConfiguration, ICompilerConfiguration, IExtensionsConfiguration, IFlexConfiguration, IFramesConfiguration, ILicensesConfiguration, IMetadataConfiguration, IMxmlConfiguration, INamespacesConfiguration, IPackagesConfiguration, IRuntimeSharedLibrarySettingsConfiguration, Cacheable, org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AsdocReportMojo, DitaAsdocMojo

public class AsdocMojo
extends AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>
implements IASDocConfiguration, IPackagesConfiguration, org.apache.maven.plugin.Mojo

Goal which generates documentation from the ActionScript sources.

Since:

1.0

Author:

Marvin Herman Froeder (velo.br@gmail.com)

Field Summary

Fields inherited from class net.flexmojos.oss.plugin.compiler.AbstractFlexCompilerMojo

benchmark, classifier, compiler, compilerName, debugPassword, finalName, includeResourceBundles, loadExterns, localesSourcePath, PROJECT_TYPE, resourceBundleNames, toolsLocale

Fields inherited from class net.flexmojos.oss.plugin.AbstractMavenMojo

AIR_GLOBAL, AIR_GROUP_ID, airVersion, archiverManager, cache, configDirectory, DATE_FORMAT, DEFAULT_RSL_URLS, DEFAULT_RUNTIME_LOCALE_OUTPUT_PATH, FLASH_GROUP_ID, flashVersion, fullSynchronization, GLOBAL_MATCHER, localRepository, packaging, PLAYER_GLOBAL, pluginArtifacts, project, projectHelper, quick, remoteRepositories, repositorySystem, resources, RETURNS_NULL, session, skip, TARGET_DIRECTORY, targetDirectory

Fields inherited from interface net.flexmojos.oss.compiler.IASDocConfiguration

BENCHMARK, BENCHMARK_COMPILER_DETAILS, BENCHMARK_TIME_FILTER, DATE_IN_FOOTER, DEBUG_PASSWORD, DEFAULT_BACKGROUND_COLOR, DEFAULT_FRAME_RATE, DEFAULT_SCRIPT_LIMITS, DEFAULT_SIZE, DOC_CLASSES, DOC_NAMESPACES, DOC_SOURCES, DUMP_CONFIG, EXAMPLES_PATH, EXCLUDE_CLASSES, EXCLUDE_DEPENDENCIES, EXCLUDE_SOURCES, EXTERNS, FOOTER, FRAMEWORK, GENERATE_FRAME_LOADER, HELP, INCLUDE_ALL_FOR_ASDOC, INCLUDE_INHERITANCE_DEPENDENCIES_ONLY, INCLUDE_LOOKUP_ONLY, INCLUDES, KEEP_XML, LAZY_INIT, LEFT_FRAMESET_WIDTH, LENIENT, LINK_REPORT, LOAD_CONFIG, LOAD_EXTERNS, MAIN_TITLE, OUTPUT, PACKAGE_DESCRIPTION_FILE, RAW_METADATA, REMOVE_UNUSED_RSLS, RESOURCE_BUNDLE_LIST, RESTORE_BUILTIN_CLASSES, RUNTIME_SHARED_LIBRARIES, RUNTIME_SHARED_LIBRARY_PATH, SIZE_REPORT, SKIP_XSL, STATIC_LINK_RUNTIME_SHARED_LIBRARIES, SWC_CHECKSUM, SWF_VERSION, TARGET_PLAYER, TEMPLATES_PATH, TOOLS_LOCALE, USE_DIRECT_BLIT, USE_GPU, USE_NETWORK, VERIFY_DIGESTS, VERSION, WARNINGS, WINDOW_TITLE

Fields inherited from interface net.flexmojos.oss.compiler.IPackagesConfiguration

PACKAGE

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Fields inherited from interface net.flexmojos.oss.compiler.ICompilerConfiguration

ACCESSIBLE, ACTIONSCRIPT_FILE_ENCODING, ADJUST_OPDEBUGLINE, ADVANCED_TELEMETRY, ALLOW_DUPLICATE_DEFAULT_STYLE_DECLARATIONS, ALLOW_SOURCE_PATH_OVERLAP, ARCHIVE_CLASSES_AND_ASSETS, AS3, COMPRESS, CONSERVATIVE, CONTEXT_ROOT, DEBUG, DEFAULTS_CSS_FILES, DEFAULTS_CSS_URL, DEFINE, DISABLE_INCREMENTAL_OPTIMIZATIONS, DOC, ENABLE_RUNTIME_DESIGN_LAYERS, ENABLE_SWC_VERSION_FILTERING, ES, EXTERNAL_LIBRARY_PATH, GENERATE_ABSTRACT_SYNTAX_TREE, HEADLESS_SERVER, INCLUDE_LIBRARIES, INCREMENTAL, ISOLATE_STYLES, JAVA_PROFILER_CLASS, KEEP_ALL_TYPE_SELECTORS, KEEP_AS3_METADATA, KEEP_GENERATED_ACTIONSCRIPT, KEEP_GENERATED_SIGNATURES, LIBRARY_PATH, LOCALE, MEMORY_USAGE_FACTOR, MINIMUM_SUPPORTED_VERSION, MOBILE, OMIT_TRACE_STATEMENTS, OPTIMIZE, PRELOADER, REPORT_INVALID_STYLES_AS_WARNINGS, REPORT_MISSING_REQUIRED_SKIN_PARTS_AS_WARNINGS, RESOURCE_HACK, SERVICES, SHOW_ACTIONSCRIPT_WARNINGS, SHOW_BINDING_WARNINGS, SHOW_DEPENDENCY_WARNINGS, SHOW_DEPRECATION_WARNINGS, SHOW_INVALID_CSS_PROPERTY_WARNINGS, SHOW_SHADOWED_DEVICE_FONT_WARNINGS, SHOW_UNUSED_TYPE_SELECTOR_WARNINGS, SIGNATURE_DIRECTORY, SOURCE_PATH, STRICT, THEME, TRANSLATION_FORMAT, USE_RESOURCE_BUNDLE_METADATA, VERBOSE_STACKTRACES, WARN_ARRAY_TOSTRING_CHANGES, WARN_ASSIGNMENT_WITHIN_CONDITIONAL, WARN_BAD_ARRAY_CAST, WARN_BAD_BOOL_ASSIGNMENT, WARN_BAD_DATE_CAST, WARN_BAD_ES3_TYPE_METHOD, WARN_BAD_ES3_TYPE_PROP, WARN_BAD_NAN_COMPARISON, WARN_BAD_NULL_ASSIGNMENT, WARN_BAD_NULL_COMPARISON, WARN_BAD_UNDEFINED_COMPARISON, WARN_BOOLEAN_CONSTRUCTOR_WITH_NO_ARGS, WARN_CHANGES_IN_RESOLVE, WARN_CLASS_IS_SEALED, WARN_CONST_NOT_INITIALIZED, WARN_CONSTRUCTOR_RETURNS_VALUE, WARN_DEPRECATED_EVENT_HANDLER_ERROR, WARN_DEPRECATED_FUNCTION_ERROR, WARN_DEPRECATED_PROPERTY_ERROR, WARN_DUPLICATE_ARGUMENT_NAMES, WARN_DUPLICATE_VARIABLE_DEF, WARN_FOR_VAR_IN_CHANGES, WARN_IMPORT_HIDES_CLASS, WARN_INSTANCE_OF_CHANGES, WARN_INTERNAL_ERROR, WARN_LEVEL_NOT_SUPPORTED, WARN_MISSING_NAMESPACE_DECL, WARN_NEGATIVE_UINT_LITERAL, WARN_NO_CONSTRUCTOR, WARN_NO_EXPLICIT_SUPER_CALL_IN_CONSTRUCTOR, WARN_NO_TYPE_DECL, WARN_NUMBER_FROM_STRING_CHANGES, WARN_SCOPING_CHANGE_IN_THIS, WARN_SLOW_TEXT_FIELD_ADDITION, WARN_UNLIKELY_FUNCTION_VALUE, WARN_XML_CLASS_HAS_CHANGED

Fields inherited from interface net.flexmojos.oss.compiler.IFramesConfiguration

FRAME

Fields inherited from interface net.flexmojos.oss.compiler.ILicensesConfiguration

LICENSE

Fields inherited from interface net.flexmojos.oss.compiler.IMetadataConfiguration

CONTRIBUTOR, CREATOR, DATE, DESCRIPTION, LANGUAGE, LOCALIZED_DESCRIPTION, LOCALIZED_TITLE, PUBLISHER, TITLE

Fields inherited from interface net.flexmojos.oss.compiler.IMxmlConfiguration

COMPATIBILITY_VERSION, MINIMUM_SUPPORTED_VERSION, QUALIFIED_TYPE_SELECTORS

Fields inherited from interface net.flexmojos.oss.compiler.INamespacesConfiguration

NAMESPACE

Fields inherited from interface net.flexmojos.oss.compiler.IExtensionsConfiguration

EXTENSION

Fields inherited from interface net.flexmojos.oss.compiler.IRuntimeSharedLibrarySettingsConfiguration

APPLICATION_DOMAIN, FORCE_RSLS

Constructor Summary

Constructors

Constructor and Description
AsdocMojo()

Method Summary

Modifier and Type	Method and Description
Result	doCompile(IASDocConfiguration cfg, boolean synchronize)
void	fmExecute()
Boolean	getDateInFooter()
List<String>	getDocClasses()
List<String>	getDocNamespaces()
File[]	getDocSources()
String	getDumpConfig()
String	getExamplesPath()
List<String>	getExcludeClasses()
Boolean	getExcludeDependencies()
File[]	getExcludeSources()
File[]	getExternalLibraryPath()
String	getFooter()
Boolean	getIncludeAllForAsdoc()
File[]	getIncludeLibraries()
Boolean	getIncludeLookupOnly()
Boolean	getKeepXml()
Integer	getLeftFramesetWidth()
Boolean	getLenient()
File[]	getLibraryPath()
String	getLinkReport()
String	getMainTitle()
String	getOutput()
String[]	getPackage()
String	getPackageDescriptionFile()
IPackagesConfiguration	getPackagesConfiguration()
Boolean	getRestoreBuiltinClasses()
IRuntimeSharedLibraryPath[]	getRuntimeSharedLibraryPath()
String	getSizeReport()
Boolean	getSkipXsl()
File[]	getSourcePath()
String	getTemplatesPath()
String	getWindowTitle()

Methods inherited from class net.flexmojos.oss.plugin.compiler.AbstractFlexCompilerMojo

adaptResourceBundle, calculateRuntimeLibraryPath, clone, configureResourceBundle, executeCompiler, getAccessible, getActionscriptFileEncoding, getAdjustOpdebugline, getAdvancedTelemetry, getAllowDuplicateDefaultStyleDeclarations, getAllowSourcePathOverlap, getApplicationDomain, getArchiveClassesAndAssets, getAs3, getBenchmark, getBenchmarkCompilerDetails, getBenchmarkTimeFilter, getClassifier, getCompatibilityVersion, getCompiledResouceBundles, getCompilerConfiguration, getCompilerOutput, getCompilerWarnings, getCompress, getConservative, getContextRoot, getContributor, getCreator, getDate, getDebug, getDebugPassword, getDefaultBackgroundColor, getDefaultFrameRate, getDefaultScriptLimits, getDefaultsCssFiles, getDefaultsCssUrl, getDefaultSize, getDefine, getDescription, getDisableIncrementalOptimizations, getDoc, getEnableRuntimeDesignLayers, getEnableSwcVersionFiltering, getEs, getExtension, getExtensionsConfiguration, getExterns, getFinalName, getFontsConfiguration, getForceRsls, getFrame, getFramesConfiguration, getFramework, getGenerateAbstractSyntaxTree, getGenerateFrameLoader, getGlobalArtifactCollection, getHeadlessServer, getHelp, getIncludeInheritanceDependenciesOnly, getIncludes, getIncremental, getIsolateStyles, getJavaProfilerClass, getKeepAllTypeSelectors, getKeepAs3Metadata, getKeepGeneratedActionscript, getKeepGeneratedSignatures, getLanguage, getLazyInit, getLicense, getLicensesConfiguration, getLoadConfig, getLoadExterns, getLocale, getLocalesRuntime, getLocalizedDescription, getLocalizedTitle, getMemoryUsageFactor, getMetadataConfiguration, getMinimumSupportedVersion, getMobile, getMxmlConfiguration, getNamespace, getNamespacesConfiguration, getNamespacesUri, getOmitTraceStatements, getOptimize, getPolicyFileUrls, getPreloader, getProjectType, getPublisher, getQualifiedTypeSelectors, getRawMetadata, getRemoveUnusedRsls, getReportInvalidStylesAsWarnings, getReportMissingRequiredSkinPartsAsWarnings, getResourceBundleList, getResourceBundleListContent, getResourceBundleListFile, getResourceHack, getRslUrls, getRuntimeSharedLibraries, getRuntimeSharedLibrarySettingsConfiguration, getServices, getShowActionscriptWarnings, getShowBindingWarnings, getShowDependencyWarnings, getShowDeprecationWarnings, getShowInvalidCssPropertyWarnings, getShowShadowedDeviceFontWarnings, getShowUnusedTypeSelectorWarnings, getSignatureDirectory, getStaticLinkRuntimeSharedLibraries, getStrict, getSwcChecksum, getSwfVersion, getTargetPlayer, getTheme, getTitle, getToolsLocale, getTranslationFormat, getUseDirectBlit, getUseGpu, getUseNetwork, getUseResourceBundleMetadata, getVerboseStacktraces, getVerifyDigests, getVersion, getWarnArrayTostringChanges, getWarnAssignmentWithinConditional, getWarnBadArrayCast, getWarnBadBoolAssignment, getWarnBadDateCast, getWarnBadEs3TypeMethod, getWarnBadEs3TypeProp, getWarnBadNanComparison, getWarnBadNullAssignment, getWarnBadNullComparison, getWarnBadUndefinedComparison, getWarnBooleanConstructorWithNoArgs, getWarnChangesInResolve, getWarnClassIsSealed, getWarnConstNotInitialized, getWarnConstructorReturnsValue, getWarnDeprecatedEventHandlerError, getWarnDeprecatedFunctionError, getWarnDeprecatedPropertyError, getWarnDuplicateArgumentNames, getWarnDuplicateVariableDef, getWarnForVarInChanges, getWarnImportHidesClass, getWarnings, getWarnInstanceOfChanges, getWarnInternalError, getWarnLevelNotSupported, getWarnMissingNamespaceDecl, getWarnNegativeUintLiteral, getWarnNoConstructor, getWarnNoExplicitSuperCallInConstructor, getWarnNoTypeDecl, getWarnNumberFromStringChanges, getWarnScopingChangeInThis, getWarnSlowTextFieldAddition, getWarnUnlikelyFunctionValue, getWarnXmlClassHasChanged, isCompilationRequired, versionCheck

Methods inherited from class net.flexmojos.oss.plugin.AbstractMavenMojo

as3ClassesFileSet, checkResult, createSwfDescriptor, execute, filterClasses, filterFiles, getAirGlobal, getAirTarget, getAirVersion, getBasedir, getBuildDirectory, getCache, getCompilerArtifact, getCompilerGroupId, getCompilerVersion, getDependencies, getDependencies, getDependency, getFdkGroupId, getFlashGlobal, getFlashVersion, getFrameworkArtifact, getFrameworkArtifactVersion, getFrameworkConfig, getFrameworkGroupId, getFrameworkVersion, getFromPluginContext, getGlobalArtifact, getIsAirProject, getIsFlashProject, getLog, getMavenLogger, getMavenPathResolver, getOutputDirectory, getPluginContext, getResourcesTargetDirectories, getSession, getTargetDirectory, getUnpackedArtifact, getUnpackedArtifact, getUnpackedFrameworkConfig, initGlobalMatcher, isSkip, putPluginContext, resolve, scan, scan, scan, setArchiverManager, setLog, setPluginContext, toClass, wait, wait

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.flexmojos.oss.compiler.IASDocConfiguration

getBenchmark, getBenchmarkCompilerDetails, getBenchmarkTimeFilter, getCompilerConfiguration, getDebugPassword, getDefaultBackgroundColor, getDefaultFrameRate, getDefaultScriptLimits, getDefaultSize, getExterns, getFramesConfiguration, getFramework, getGenerateFrameLoader, getHelp, getIncludeInheritanceDependenciesOnly, getIncludes, getLazyInit, getLicensesConfiguration, getLoadConfig, getLoadExterns, getMetadataConfiguration, getRawMetadata, getRemoveUnusedRsls, getResourceBundleList, getRuntimeSharedLibraries, getRuntimeSharedLibrarySettingsConfiguration, getStaticLinkRuntimeSharedLibraries, getSwcChecksum, getSwfVersion, getTargetPlayer, getToolsLocale, getUseDirectBlit, getUseGpu, getUseNetwork, getVerifyDigests, getVersion, getWarnings

Methods inherited from interface org.apache.maven.plugin.Mojo

execute, getLog, setLog

Methods inherited from interface net.flexmojos.oss.plugin.compiler.lazyload.Cacheable

getCache

Methods inherited from interface net.flexmojos.oss.compatibilitykit.FlexMojo

getCompilerVersion

Constructor Detail

AsdocMojo

public AsdocMojo()

Method Detail

doCompile

public Result doCompile(IASDocConfiguration cfg,
                        boolean synchronize)
                 throws Exception

Specified by:

doCompile in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

Throws:

Exception

fmExecute

public void fmExecute()
               throws org.apache.maven.plugin.MojoExecutionException,
                      org.apache.maven.plugin.MojoFailureException

Specified by:

fmExecute in class AbstractMavenMojo

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

getDateInFooter

public Boolean getDateInFooter()

Specified by:

getDateInFooter in interface IASDocConfiguration

getDocClasses

public List<String> getDocClasses()

Specified by:

getDocClasses in interface IASDocConfiguration

getDocNamespaces

public List<String> getDocNamespaces()

Specified by:

getDocNamespaces in interface IASDocConfiguration

getDocSources

public File[] getDocSources()

Specified by:

getDocSources in interface IASDocConfiguration

getDumpConfig

public String getDumpConfig()

Specified by:

getDumpConfig in interface IASDocConfiguration

Overrides:

getDumpConfig in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getExamplesPath

public String getExamplesPath()

Specified by:

getExamplesPath in interface IASDocConfiguration

getExcludeClasses

public List<String> getExcludeClasses()

Specified by:

getExcludeClasses in interface IASDocConfiguration

getExcludeDependencies

public Boolean getExcludeDependencies()

Specified by:

getExcludeDependencies in interface IASDocConfiguration

getExcludeSources

public File[] getExcludeSources()

Specified by:

getExcludeSources in interface IASDocConfiguration

getExternalLibraryPath

public File[] getExternalLibraryPath()

Specified by:

getExternalLibraryPath in interface ICompilerConfiguration

Overrides:

getExternalLibraryPath in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getFooter

public String getFooter()

Specified by:

getFooter in interface IASDocConfiguration

getIncludeAllForAsdoc

public Boolean getIncludeAllForAsdoc()

Specified by:

getIncludeAllForAsdoc in interface IASDocConfiguration

getIncludeLibraries

public File[] getIncludeLibraries()

Specified by:

getIncludeLibraries in interface ICompilerConfiguration

Overrides:

getIncludeLibraries in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getIncludeLookupOnly

public Boolean getIncludeLookupOnly()

Specified by:

getIncludeLookupOnly in interface IASDocConfiguration

getKeepXml

public Boolean getKeepXml()

Specified by:

getKeepXml in interface IASDocConfiguration

getLeftFramesetWidth

public Integer getLeftFramesetWidth()

Specified by:

getLeftFramesetWidth in interface IASDocConfiguration

getLenient

public Boolean getLenient()

Specified by:

getLenient in interface IASDocConfiguration

getLibraryPath

public File[] getLibraryPath()

Specified by:

getLibraryPath in interface ICompilerConfiguration

Overrides:

getLibraryPath in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getLinkReport

public String getLinkReport()

Specified by:

getLinkReport in interface IASDocConfiguration

Overrides:

getLinkReport in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getMainTitle

public String getMainTitle()

Specified by:

getMainTitle in interface IASDocConfiguration

getOutput

public String getOutput()

Specified by:

getOutput in interface IASDocConfiguration

Overrides:

getOutput in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getPackage

public String[] getPackage()

Specified by:

getPackage in interface IPackagesConfiguration

getPackageDescriptionFile

public String getPackageDescriptionFile()

Specified by:

getPackageDescriptionFile in interface IASDocConfiguration

getPackagesConfiguration

public IPackagesConfiguration getPackagesConfiguration()

Specified by:

getPackagesConfiguration in interface IASDocConfiguration

getRestoreBuiltinClasses

public Boolean getRestoreBuiltinClasses()

Specified by:

getRestoreBuiltinClasses in interface IASDocConfiguration

getRuntimeSharedLibraryPath

public IRuntimeSharedLibraryPath[] getRuntimeSharedLibraryPath()

Specified by:

getRuntimeSharedLibraryPath in interface IASDocConfiguration

Overrides:

getRuntimeSharedLibraryPath in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getSizeReport

public String getSizeReport()

Specified by:

getSizeReport in interface IASDocConfiguration

Overrides:

getSizeReport in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getSkipXsl

public Boolean getSkipXsl()

Specified by:

getSkipXsl in interface IASDocConfiguration

getSourcePath

public File[] getSourcePath()

Specified by:

getSourcePath in interface ICompilerConfiguration

Overrides:

getSourcePath in class AbstractFlexCompilerMojo<IASDocConfiguration,AsdocMojo>

getTemplatesPath

public String getTemplatesPath()

Specified by:

getTemplatesPath in interface IASDocConfiguration

getWindowTitle

public String getWindowTitle()

Specified by:

getWindowTitle in interface IASDocConfiguration