org.netbeans.nbbuild |
Various Ant tasks used during the NetBeans build process.
Of especial interest to module developers are:
<makenbm>
<genlist>
- Create NBM files for Auto Update, and create update tracking files to list
the files contained in an NBM.
<jhindexer>
<checklinks>
<checkhelpsets>
- Create search databases for JavaHelp help sets. Check those help sets, or
any other sets of HTML files, for broken links.
<arch>
- Create a high-level architectural summary of your module and how it
interacts with the complete application, based on a premade XML-based
questionnaire.
Of especial interest to those creating a complete NetBeans distribution:
<createmodulexml>
- Pregenerate the files system/Modules/*.xml in a NetBeans
distribution, so that they are not created in the user directory when NetBeans
is first started.
<makeupdatedesc>
- Create an XML file which can be put on a webserver that Auto Update can
connect to in order to get a list of NBMs that it can install - create your own
update center.
|
Java Source File Name | Type | Comment |
Arch.java | Class | Task to process Arch questions and answers document. |
ArchQuestionsTest.java | Class | Check the behaviour Arch task. |
Branding.java | Class | Packs override resources into branding JARs with the correct paths. |
CheckBundles.java | Class | Task that scans Bundle.properties files for unused keys. |
CheckHelpSets.java | Class | Task to check various aspects of JavaHelp helpsets. |
CheckHelpSetsBin.java | Class | Task to check various aspects of JavaHelp helpsets. |
CheckLicense.java | Class | Check source files for a license notice. |
CheckLicenseTest.java | Class | |
CheckLinks.java | Class | Task to check for broken links in HTML. |
CheckLinksTest.java | Class | Check the behaviour of CheckLinks. |
CheckModuleConfigs.java | Class | Analyzes build.properties and cluster.properties and tries to diagnose any problems. |
CheckValue.java | Class | Task to check value of any property. |
CleanAll.java | Class | Runs a clean task (for example) in all submodules. |
ConfigureModules.java | Class | Set a default list of modules for a given configuration. |
ConvertImport.java | Class | It replaces paths in import element of buildscript. |
ConvertImportTest.java | Class | |
CopyIcons.java | Class | Task for copying out icons from NetBeans projects. |
CreateModuleXML.java | Class | Create XML files corresponding to the set of known modules
without actually running the IDE. |
CreateModuleXMLTest.java | Class | Check behaviour of ModuleSelector. |
DeleteUnreferencedClusterFiles.java | Class | Removes files from clusters which are not listed as belonging to any NBM. |
ExportedAPICondition.java | Class | Condition that determines whether a given module exports an API.
This is true if any of the following hold:
- The module lists public API packages.
- The module lists friend API packages, and at least one friend is external (not known in module universe).
- The module lists friend API packages, and at least one friend is located in a different cluster.
This condition must be called from a module build, which is why it accepts no parameters:
various properties are picked up from the project. |
FindBadConstructions.java | Class | Task to search some files for bad constructions. |
FixDependencies.java | Class | Assistent in changing of build scripts. |
FixDependenciesTest.java | Class | Behaviour of fixing module dependencies. |
FixTestDependencies.java | Class | |
FixTestDependenciesTest.java | Class | |
ForEach.java | Class | For each specified location call ant task with specified target name. |
ForEachTest.java | Class | |
GenerateJavadoc.java | Class | |
GetDependsClusters.java | Class | |
GetL9eFiles.java | Class | This task copies the localizable files to a directory. |
GetModuleName.java | Class | |
IncrementSpecificationVersions.java | Class | Increments specification versions of all specified modules,
in the trunk or in a branch, in a regulated manner. |
IncrementSpecificationVersionsTest.java | Class | Test for increments of spec versions. |
InsertModuleAllTargets.java | Class | Insert into the live project some all-* targets.
This means they do not need to manually written into nbbuild/build.xml.
Targets are only added for projectized modules which do not already
have all-* entries in the build script.
Generally, an all-* target for a projectized module in a named cluster depends on:
1. |
Issue.java | Class | Represents on issue in issuezilla. |
JarWithModuleAttributes.java | Class | Task just like but predefines various module attributes.
Cf. |
JarWithModuleAttributesTest.java | Class | Checks that javac.target gets reflected in the manifest. |
JavadocIndex.java | Class | Generates a file with index of all files. |
JHIndexer.java | Class | Task to run JavaHelp search indexer. |
JUnitReportWriter.java | Class | Utility permitting Ant tasks to write out JUnit-format reports rather than aborting the build. |
Kvetcher.java | Class | Task to complain (via email) to people when things fail in a build.
XXX In Ant 1.4 this could be better written using TaskContainer, probably.
XXX support fallback address for errors not otherwise handled
XXX do not send the same error to more than one culprit
XXX support ignore patterns for errors, to be useful with e.g. |
L10nTask.java | Class | This task was created to create L10N kits.
The xml to call this task might look like:
Each resulting kit will be a tar file containing one directory
for each repository examined.
Each repository_directory will contain one tar-file
for each module with changed localizable files.
The structure of the tar file is as follows:
repository_dir/
module_tar/
generatedFile
contentFile
localizableFile1.html
localizableFile2.gif...
1. |
LayerIndex.java | Class | Task to scan all XML layers in a NB installation
and report on which modules registers which files. |
LocalizedJar.java | Class | Create a JAR file with locale variants.
Whenever files are found which should be localized, or are the result
of localization, places them in separate JAR files named according to the locale,
in a locale/ subdirectory of the directory containing the master JAR.
Each sub-JAR gets a manifest which just has some informational tags
indicating its purpose (locale and branding):
X-Informational-Archive-Locale and/or X-Informational-Archive-Branding .
The values may be e.g. |
LocJHIndexer.java | Class | This task runs the JHIndexer task multiple times, once for each
language, and automatically creates the appropriate regular
expressions to choose the files for each language. |
LocMakeNBM.java | Class | Runs the makenbm task for each locale specified in the
global property locmakenbm.locales. |
MakeJNLP.java | Class | Generates JNLP files for signed versions of the module JAR files. |
MakeJNLPTest.java | Class | |
MakeLayer.java | Class | Create a fragment of a module's XML layer. |
MakeListOfNBM.java | Class | Create an update tracking file automatically. |
MakeLNBM.java | Class | Makes a localized .nbm (NetBeans Module) file. |
MakeMasterJNLP.java | Class | Generates JNLP files for signed versions of the module JAR files. |
MakeMasterJNLPTest.java | Class | |
MakeNBM.java | Class | Makes a .nbm (NetBeans Module) file. |
MakeNBMTest.java | Class | |
MakeUpdateDesc.java | Class | Makes an XML file representing update information from NBMs. |
ModuleDependencies.java | Class | |
ModuleDependenciesTest.java | Class | Check the behaviour ModuleDependencies task that prints out info about
module dependencies, etc. |
ModuleListParser.java | Class | Scans for known modules. |
ModuleListParserTest.java | Class | Test
ModuleListParser . |
ModuleSelector.java | Class | Selector that accepts modules based on their code base name. |
ModuleSelectorTest.java | Class | Check behaviour of ModuleSelector. |
ModuleTestDependencies.java | Class | Produces a list of all compile-time dependencies between unit tests of modules. |
NbEnhanceClass.java | Class | |
NbMerge.java | Class | Pseudo-task to unpack a set of modules. |
NbPatchClass.java | Class | |
ParseProjectXml.java | Class | Parse a projectized module's nbproject/project.xml and
define various useful Ant properties based on the result. |
Postprocess.java | Class | Changes content of a binary file. |
Preprocess.java | Class | Preprocesses content of file replacing all conditional blocks.
/*nbif someswitch
// PART A
nbelse*/
// PART B
/*nbend*/
If someswitch is off, nothing will be changed, so part A will be
commented-out and part B will be active. |
PrintIcon.java | Class | |
PrintIconTest.java | Class | |
PublicPackagesInProjectizedXMLTest.java | Class | Check the behaviour of in project.xml modules. |
RecursiveDepsTest.java | Class | |
Repeat.java | Class | |
ResolveList.java | Class | |
SetCluster.java | Class | |
ShorterPaths.java | Class | Replace paths prefixes with variables. |
ShorterPathsTest.java | Class | |
Sigtest.java | Class | Invokes signature tests. |
SimpleMerge.java | Class | Copies content of subdirectories of defined name from set of directories
to a certain location. |
SortSuiteModules.java | Class | Task to sort the list of modules in a suite by their declared build dependencies. |
SortSuiteModulesTest.java | Class | |
SubAntJUnitReport.java | Class | Akin to (a simple subset of) <subant> but failures in subtasks are collected
and optionally sent to a JUnit-format report rather than halting the build. |
TestDepsTest.java | Class | |
TestDistFilter.java | Class | It scans test distribution ant sets to property with name defined by param
'testListProperty'path with filtered test. |
TestDistFilterTest.java | Class | |
UpdateTracking.java | Class | |
ValidatePath.java | Class | Fails if any path element is misssing. |
ValidatePathTest.java | Class | |
VerifyClassLinkage.java | Class | Verifies linkage between classes in a JAR (typically a module). |
VerifyJNLP.java | Class | Validates the syntax and semantics of one or more JNLP files. |
VerifyUpdateCenter.java | Class | Task which checks content of an update center to make sure module dependencies
are internally consistent. |
XMLUtil.java | Class | Utility class collecting library methods related to XML processing. |
XTest2JUnitResultFormatter.java | Class | Translates XTest test results into the de facto standard XML report format used by JUnit. |