com.feathersui.maven.plugin.lime_openfl

Class GenerateProjectXmlMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.feathersui.maven.plugin.lime_openfl.GenerateProjectXmlMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

@Mojo(name="generate-project-xml",
      defaultPhase=GENERATE_RESOURCES)
public class GenerateProjectXmlMojo
extends org.apache.maven.plugin.AbstractMojo

Generates a project.xml file for a Lime, OpenFL, or Feathers UI project. Intended for developers who prefer to have all of their build configuration in the Maven pom.xml file, and would rather not maintain two separate files.

Hint: If you already have a Lime project.xml file, you don't need to generate one. You can simply keep your existing file. If your project.xml file is the same directory as pom.xml, it will be detected automatically, and you don't need to configure anything to use it. However, if project.xml is in a different directory from pom.xml, you can specify the BaseMojo.projectFile parameter to tell the plugin where it is located.

The project configuration may be specified using the limeProject parameter. See LimeProject for complete details.

 
 <build>
   <plugins>
     <plugin>
       <groupId>com.feathersui.maven.plugins</groupId>
       <artifactId>lime-openfl-maven-plugin</artifactId>
       <version>1.0.0</version>
       <extensions>true</extensions>
       <configuration>
         <limeProject>
           <!-- configure project here -->
         </limeProject>
       </configuration>
     </plugin>
   </plugins>
 </build>
 
 

See Also:

LimeProject

Field Summary

Fields

Modifier and Type	Field and Description
protected File	basedir
LimeProject	limeProject Allows you to configure the project inside your Maven pom.xml file.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
GenerateProjectXmlMojo()

Method Summary

Modifier and Type	Method and Description
void	execute() Generates the Lime project.xml file.

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

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

Field Detail

limeProject

@Parameter
public LimeProject limeProject

Allows you to configure the project inside your Maven pom.xml file. See LimeProject for complete details.

The following example demonstrates where the <limeProject> parameter should be added:

 
 <build>
   <plugins>
     <plugin>
       <groupId>com.feathersui.maven.plugins</groupId>
       <artifactId>lime-openfl-maven-plugin</artifactId>
       <version>1.0.0</version>
       <extensions>true</extensions>
       <configuration>
         <limeProject>
           <!-- configure project here -->
         </limeProject>
       </configuration>
     </plugin>
   </plugins>
 </build>
 
 

basedir

@Parameter(defaultValue="${basedir}",
           required=true,
           readonly=true)
protected File basedir

Constructor Detail

GenerateProjectXmlMojo

public GenerateProjectXmlMojo()

Method Detail

execute

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

Generates the Lime project.xml file.

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException