Download - NetBeans

More documents

Recommendations

Info

NetBeans Platform Development with Maven 2The reason is that no default Maven pluginknows how to handle the nbm packaging.We need to add the nbm-maven-plugin(which I’ll call “NBM Plugin” from now on)inside the element in the POM.See Listing 1.Now the project will build successfully.After the build, switch to the Files tab andyou’ll notice in the target folder all the extraartifacts, including the generated NBMfile (see Figure 5). At this point we havea working module project; by clicking Runyou’ll get a new IDE running, which shouldinclude our module among many others.CYou might get errors related to Windows pathswhile trying to run the project. Make sure you don’thave spaces in these paths, as these are usuallythe culprits.A 4tion class. It also changes the layer file and adds thecorresponding dependency to the POM.At this point, any build using Platform APIs will fail,as the Maven project doesn’t have a dependency onthe needed Platform-specific artifacts. First we needto declare the repository where the NetBeans artifactsare located; see Listing 2. Next we include adependency on org-openide-util, which is the moduleproviding the Platform’s Actions API. See Listing 3.This is equivalent to a dependency added to a normalPlatform module. The NBM Plugin will detect that this artifactis a module and configure the proper dependency in the generatedbuild artifact. As before, the project won’t initially compilewithout the dependency; this will be resolved when the files aredownloaded on the first build.CRegarding Listing 3, if the version RELEASE60 doesn’t work for you, tryRELEASE60-BETA2 as the new bits might not yet have reached the Mavenrepository when you read this.BListing 1. Build configuration for the NBM Plugin...org.codehaus.mojonbm-maven-pluginRELEASEtrue...AFigure 4.New Maven project,with errors that willbe solved with thefirst buildAdding an ActionWe will now create a newPlatform Action using theNew Action wizard. Thepurpose of this Action willbe just to inspect that agiven service exists andshow a dialog. The wizardautomatically generatesthe Bundle.properties filein the proper Maven-friendlyfolder, as well as the Ac-BListing 2. Declaring a default repository for NetBeans artifacts...netbeansRepository for hosting NetBeans API artifactshttp://deadlock.netbeans.org/maven2/truefalseIssue 4 N 41
Module DevelopmentBleeding edgeNetBeans APIdocsbits.netbeans.org/dev/javadocNow right click on the project node and create an Action withdefault options. Upon building the project, you might get a warningabout Java sources being 1.4 due to some @Override annotationswhich are 1.5 specific. You can just delete the annotations.CAll the basic Platform modules have the groupId org.netbeans.api and theJAR name as the artifactId. If you don’t know the groupId/artifactId for a module,you can try finding it in the repository at http://deadlock.netbeans.org/maven2.Other NetBeansPlatform specific settingsSo far our module does little to interact with the NetBeans Platform.Sure, by adding a dependency on org-openide-util we can alreadyuse the lookup service for example, but we can’t yet declarea service in the global lookup.The standard NetBeans way in this case is to place a textfile under META-INF/services. Luckily this is almost the sameunder Maven, with a twist: while the Java source files sit undersrc/main/java, all resources must be under src/main/resources.Cof the file under META-INF/services arethe same as usual. Respectively: theservice base class or interface; and thefully qualified name of the implementingclasses, each in its own line.The layer fileNow, in order to have menu items ortoolbars we need a layer file. The necessaryconfiguration task is letting thebuild plugin know which is your layer file.In order to do this, you need to create aplugin configuration file (an NBM descriptor),which defines the module metadatayou’d expect: cluster name, module type,update center URL, codebase, manifest,resources folder). In the new folder, cre-This Maven-specific separation of resource files from Java source files means ate a file called module.xml with contentsextra work if you plan to migrate an existing project to Maven. You’ll have to similar to Listing 4.write a script that splits the files that were together in the older project (or doit by hand).BListing 3. Adding openide-util as a dependencyetc.First, create the src/main/nbm folder.This is where you’ll put the descriptor asa special configuration file (and not in theThe resources folder may be createdoutside the IDE, or inside it from the Filestab (under src/main). It will also be automaticallycreated by the Actions wizard.After this, you should see anothernode in the Projects window called OtherSources, containing your resource files(see Figure 6).CThe resources folder onlyholds resources that belong tothe artifact. It does not containfor example the POM file orother Maven configuration files.The contents and name......org.netbeans.apiorg-openide-utilRELEASE60...BListing 4. NBM Plugin descriptor file: module.xmlnormalro.emilianbold.nbmagazine.tutorial/1nbmagazinesrc/main/nbm/manifest.mfhttp://emilianbold.ro/nbmagazine/GNU GPL 3src/main/nbm/license.txt42 N NetBeans Magazine
Page 1 and 2: NetBeansPlatformMavenDevelopment wi
Page 3: Module DevelopmentAFigure 2.Selecti
Page 7 and 8: Module DevelopmentAFigure 6.Other S
Page 9 and 10: Module DevelopmentAFigure 7.Our hel

Download - NetBeans

Create successful ePaper yourself

Delete template?

Save as template?