com.feathersui.maven.plugin.lime_openfl

Class LimeProject

java.lang.Object

com.feathersui.maven.plugin.lime_openfl.LimeProject

Direct Known Subclasses:

Section

public class LimeProject
extends Object

Defines a Lime, OpenFL, or Feathers UI project in your Maven pom.xml file for GenerateProjectXmlMojo.

To define your project configuration, add a <limeProject> parameter to the <configuration> section for lime-openfl-maven-plugin in your Maven pom.xml file.

 
 <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>
           <app>
             <main>com.example.MyApp</main>
             <file>myapp</file>
           </app>
           <window>
             <fps>60</fps>
             <allowHighDpi>true</allowHighDpi>
           </window>
           <haxelibs>
             <haxelib>openfl</haxelib>
             <haxelib>actuate</haxelib>
           </haxelib>
           <icons>
             <icon>assets/myapp-icon.svg</icon>
           </icons>
         </limeProject>
       </configuration>
     </plugin>
   </plugins>
 </build>
 
 

Warning: While the Lime project.xml file and the Maven pom.xml file are both forms of XML, and they both represent the same data, they don't have the exact same format, so you cannot simply copy/paste between the two. See the examples in this documentation to learn how to define a Lime project in your Maven pom.xml file. Links to the Lime project.xml format are for reference purposes only.

See Also:

Lime project.xml format

Field Summary

Fields

Modifier and Type	Field and Description
App	app Represents the <app> element of the Lime project.xml format.
Architecture[]	architectures Represents the <architecture> element of the Lime project.xml format.
Assets[]	assets Represents the <assets> element of the Lime project.xml format.
Certificate[]	certificates Represents the <certificate> element of the Lime project.xml format.
Dependency[]	dependencies Represents the <dependency> element of the Lime project.xml format.
HaxeDef[]	haxedefs Represents the <haxedef> element of the Lime project.xml format.
HaxeFlag[]	haxeflags Represents the <haxeflag> element of the Lime project.xml format.
Haxelib[]	haxelibs Represents the <haxelib> element of the Lime project.xml format.
Icon[]	icons Represents the <icon> element of the Lime project.xml format.
Include[]	includes Represents the <include> element of the Lime project.xml format.
Java[]	java Represents the <java> element of the Lime project.xml format.
Language[]	languages Represents the <language> element of the Lime project.xml format.
LaunchImage	launchImage Represents the <launchImage> element of the Lime project.xml format.
Library[]	libraries Represents the <library> element of the Lime project.xml format.
Meta	meta Represents the <meta> element of the Lime project.xml format.
Ndll[]	ndlls Represents the <ndll> element of the Lime project.xml format.
SystemPath[]	paths Represents the <path> element of the Lime project.xml format.
PostBuild[]	postbuilds Represents the <postbuild> element of the Lime project.xml format.
PreBuild[]	prebuilds Represents the <prebuild> element of the Lime project.xml format.
Sample[]	samples Represents the <sample> element of the Lime project.xml format.
Section[]	sections Represents the <section> element of the Lime project.xml format.
SetEnv[]	setenvs Represents the <setenv> element of the Lime project.xml format.
Source[]	sources Represents the <source> element of the Lime project.xml format.
Template[]	templates Represents the <template> element of the Lime project.xml format.
Window	window Represents the <window> element of the Lime project.xml format.

Constructor Summary

Constructors

Constructor and Description
LimeProject()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

app

public App app

Represents the <app> element of the Lime project.xml format.

The following example sets the App.main and App.file fields.

 
 <limeProject>
   <app>
     <main>com.example.MyApp</main>
     <file>myapp</file>
   </app>
 </limeProject>
 
 

See Also:

App, Lime project.xml format: <app>

meta

public Meta meta

Represents the <meta> element of the Lime project.xml format.

The following example sets the Meta.title and Meta.description fields.

 
 <limeProject>
   <meta>
     <title>My Cool Application</title>
     <description>Get more stuff done with My Cool App</description>
   </meta>
 </limeProject>
 
 

See Also:

Meta, Lime project.xml format: <meta>

window

public Window window

Represents the <window> element of the Lime project.xml format.

The following example sets the Window.fps and Window.allowHighDpi fields.

 
 <limeProject>
   <window>
     <fps>60</fps>
     <allowHighDpi>true</allowHighDpi>
   </window>
 </limeProject>
 
 

See Also:

Window, Lime project.xml format: <window>

sources

public Source[] sources

Represents the <source> element of the Lime project.xml format.

Hint: If the <sources> element is not defined, src/main/haxe is added by default.

The following example sets a custom <sources> element.

 
 <limeProject>
   <sources>
     <source>src/main/haxe</source>
     <source>foo/bar/baz</source>
   </sources>
 </limeProject>
 
 

See Also:

Source, Lime project.xml format: <source>

haxelibs

public Haxelib[] haxelibs

Represents the <haxelib> element of the Lime project.xml format.

Hint: If the <haxelibs> element is not defined, or if lime or openfl is not included, lime is added by default.

The following example sets a custom <haxelibs> element.

 
 <limeProject>
   <haxelibs>
     <haxelib>
       <name>openfl</name>
       <version>9.2.0</version>
     </haxelib>
     <haxelib>actuate</haxelib>
     <haxelib>feathersui</haxelib>
   </haxelibs>
 </limeProject>
 
 

See Also:

Haxelib, Lime project.xml format: <haxelib>

haxedefs

public HaxeDef[] haxedefs

Represents the <haxedef> element of the Lime project.xml format.

See Also:

HaxeDef, Lime project.xml format: <haxedef>

haxeflags

public HaxeFlag[] haxeflags

Represents the <haxeflag> element of the Lime project.xml format.

See Also:

HaxeFlag, Lime project.xml format: <haxeflag>

languages

public Language[] languages

Represents the <language> element of the Lime project.xml format.

See Also:

Language, Lime project.xml format: <language>

dependencies

public Dependency[] dependencies

Represents the <dependency> element of the Lime project.xml format.

See Also:

Dependency, Lime project.xml format: <dependency>

templates

public Template[] templates

Represents the <template> element of the Lime project.xml format.

See Also:

Template, Lime project.xml format: <template>

includes

public Include[] includes

Represents the <include> element of the Lime project.xml format.

See Also:

Include, Lime project.xml format: <include>

icons

public Icon[] icons

Represents the <icon> element of the Lime project.xml format.

See Also:

Icon, Lime project.xml format: <icon>

assets

public Assets[] assets

Represents the <assets> element of the Lime project.xml format.

See Also:

Assets, Lime project.xml format: <assets>

libraries

public Library[] libraries

Represents the <library> element of the Lime project.xml format.

See Also:

Library, Lime project.xml format: <library>

java

public Java[] java

Represents the <java> element of the Lime project.xml format.

See Also:

Java, Lime project.xml format: <java>

launchImage

public LaunchImage launchImage

Represents the <launchImage> element of the Lime project.xml format.

See Also:

LaunchImage, Lime project.xml format: <launchimage>

certificates

public Certificate[] certificates

Represents the <certificate> element of the Lime project.xml format.

See Also:

Certificate, Lime project.xml format: <certificate>

ndlls

public Ndll[] ndlls

Represents the <ndll> element of the Lime project.xml format.

See Also:

Ndll, Lime project.xml format: <ndll>

paths

public SystemPath[] paths

Represents the <path> element of the Lime project.xml format.

See Also:

SystemPath, Lime project.xml format: <path>

samples

public Sample[] samples

Represents the <sample> element of the Lime project.xml format.

See Also:

Sample, Lime project.xml format: <sample>

setenvs

public SetEnv[] setenvs

Represents the <setenv> element of the Lime project.xml format.

See Also:

SetEnv, Lime project.xml format: <setenv>

architectures

public Architecture[] architectures

Represents the <architecture> element of the Lime project.xml format.

See Also:

Architecture, Lime project.xml format: <architecture>

prebuilds

public PreBuild[] prebuilds

Represents the <prebuild> element of the Lime project.xml format.

See Also:

PreBuild, Lime project.xml format: <prebuild>

postbuilds

public PostBuild[] postbuilds

Represents the <postbuild> element of the Lime project.xml format.

See Also:

PostBuild, Lime project.xml format: <postbuild>

sections

public Section[] sections

Represents the <section> element of the Lime project.xml format.

See Also:

Section, Lime project.xml format: <section>

Constructor Detail

LimeProject

public LimeProject()