Skip to content

Commit 10677f4

Browse files
alvarosanchezalvarosanchez
committed
Deploying to gh-pages - 07:05:49
1 parent 918480b commit 10677f4

540 files changed

Lines changed: 92582 additions & 3715 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎5.0.0-RC1/aot-analysis-mojo.html‎

Lines changed: 284 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,284 @@
1+
<!DOCTYPE html>
2+
3+
4+
<!--
5+
| Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.2:report at 2026-05-15
6+
| Rendered using Apache Maven Fluido Skin 2.0.0-M11
7+
-->
8+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
9+
<head>
10+
<meta charset="UTF-8" />
11+
<meta name="viewport" content="width=device-width, initial-scale=1" />
12+
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
13+
<title>mn:aot-analysis – Micronaut Maven Plugin - Plugin</title>
14+
<link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0-M11.min.css" />
15+
<link rel="stylesheet" href="./css/site.css" />
16+
<link rel="stylesheet" href="./css/print.css" media="print" />
17+
<script src="./js/apache-maven-fluido-2.0.0-M11.min.js"></script>
18+
<style>.github-fork-ribbon:before { background-color: black; }</style>
19+
</head>
20+
<body class="topBarEnabled">
21+
<a class="github-fork-ribbon right-top" href="https://github.com/micronaut-projects/micronaut-maven-plugin" data-ribbon="Fork me on GitHub">Fork me on GitHub</a>
22+
<header id="topbar" class="navbar navbar-fixed-top ">
23+
<div class="navbar-inner">
24+
<div class="container">
25+
<a data-target=".nav-collapse" data-toggle="collapse" class="btn btn-navbar">
26+
<span class="icon-bar"></span>
27+
<span class="icon-bar"></span>
28+
<span class="icon-bar"></span>
29+
</a>
30+
<nav class="nav-collapse">
31+
<a class="brand" href="index.html"><img src="https://micronaut.io/wp-content/uploads/2021/10/favicon-16x16-1.png" alt="Micronaut Logo" />
32+
</a>
33+
<ul class="nav">
34+
<li class="dropdown">
35+
<a class="dropdown-toggle" data-toggle="dropdown">Overview <b class="caret"></b></a>
36+
<ul class="dropdown-menu">
37+
<li><a href="index.html">Introduction</a></li>
38+
<li><a href="plugin-info.html">Goals</a></li>
39+
<li><a href="release-history.html">Release History</a></li>
40+
</ul>
41+
</li>
42+
<li class="dropdown">
43+
<a class="dropdown-toggle" data-toggle="dropdown">Examples <b class="caret"></b></a>
44+
<ul class="dropdown-menu">
45+
<li><a href="examples/run.html">Running in development mode</a></li>
46+
<li><a href="examples/package.html">Packaging</a></li>
47+
<li><a href="dockerfile-mojo.html">Generating Dockerfiles</a></li>
48+
<li><a href="examples/deploy.html">Deploying Docker images</a></li>
49+
<li><a href="examples/aot.html">Using Micronaut AOT</a></li>
50+
<li><a href="examples/test-resources.html">Integration with Micronaut Test Resources</a></li>
51+
<li><a href="examples/openapi.html">Generating OpenAPI clients or servers</a></li>
52+
<li><a href="examples/bean-import.html">Importing beans from project dependencies</a></li>
53+
<li><a href="examples/jsonschema.html">Generating Sources from JSON Schema</a></li>
54+
<li><a href="examples/configuration-validation.html">Validating Micronaut configuration</a></li>
55+
</ul>
56+
</li>
57+
<li class="dropdown">
58+
<a class="dropdown-toggle" data-toggle="dropdown">Project Documentation <b class="caret"></b></a>
59+
<ul class="dropdown-menu">
60+
<li class="dropdown-submenu">
61+
<a href="project-info.html">Project Information</a>
62+
<ul class="dropdown-menu">
63+
<li><a href="ci-management.html">CI Management</a></li>
64+
<li><a href="dependencies.html">Dependencies</a></li>
65+
<li><a href="dependency-info.html">Maven Coordinates</a></li>
66+
<li><a href="issue-management.html">Issue Management</a></li>
67+
<li><a href="licenses.html">Licenses</a></li>
68+
<li><a href="plugin-management.html">Plugin Management</a></li>
69+
<li><a href="plugins.html">Plugins</a></li>
70+
<li><a href="scm.html">Source Code Management</a></li>
71+
<li><a href="summary.html">Summary</a></li>
72+
<li><a href="team.html">Team</a></li>
73+
</ul>
74+
</li>
75+
<li class="dropdown-submenu">
76+
<a href="project-reports.html">Project Reports</a>
77+
<ul class="dropdown-menu">
78+
<li><a href="plugin-info.html">Plugin Details</a></li>
79+
<li><a href="apidocs/index.html">Javadoc</a></li>
80+
<li><a href="testapidocs/index.html">Test Javadoc</a></li>
81+
<li><a href="checkstyle.html">Checkstyle</a></li>
82+
</ul>
83+
</li>
84+
</ul>
85+
</li>
86+
</ul>
87+
</nav>
88+
<div class="nav-collapse">
89+
<form id="search-form" action="https://www.google.com/search" method="get" class="navbar-search pull-right">
90+
<input value="github.com/micronaut-projects/micronaut-maven-plugin" name="sitesearch" type="hidden" />
91+
<input class="search-query" name="q" id="query" type="text" placeholder="Search with Google..." />
92+
</form>
93+
<ul class="nav pull-right" style="border:none; margin-top: 7px"><li>
94+
<a href="https://twitter.com/micronautfw" class="twitter-follow-button" data-show-count="true" data-align="right" data-size="large" data-show-screen-name="true" data-lang="en" data-dnt="true" >Follow micronautfw</a>
95+
<script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>
96+
</li></ul>
97+
<ul class="nav pull-right">
98+
<li class="dropdown">
99+
<a class="dropdown-toggle" data-toggle="dropdown">External Links <b class="caret"></b></a>
100+
<ul class="dropdown-menu">
101+
<li><a href="https://micronaut.io" class="externalLink">Micronaut</a></li>
102+
</ul>
103+
</li>
104+
</ul>
105+
</div>
106+
</div>
107+
</div>
108+
</header>
109+
<div class="container container-top">
110+
<header>
111+
<div id="banner">
112+
<div class="pull-left"></div>
113+
<div class="pull-right"></div>
114+
<div class="clear"><hr/></div>
115+
</div>
116+
117+
<div id="breadcrumbs">
118+
<ul class="breadcrumb">
119+
<li id="publishDate">Last Published: 2026-05-15<span class="divider">|</span>
120+
</li>
121+
<li id="projectVersion">Version: 5.0.0-RC1</li>
122+
</ul>
123+
</div>
124+
</header>
125+
<main id="bodyColumn">
126+
<section><a id="mn.3Aaot-analysis"></a>
127+
<h1>mn:aot-analysis</h1>
128+
<p><strong>Full name</strong>:</p>
129+
<p>io.micronaut.maven:micronaut-maven-plugin:5.0.0-RC1:aot-analysis</p>
130+
<p><strong>Description</strong>:</p>
131+
<p><p>Invokes the <a href="https://micronaut-projects.github.io/micronaut-aot/latest/guide/">Micronaut AOT</a> optimizer, generating sources/classes and the effective AOT configuration properties file. Refer to the Micronaut AOT documentation for more information.</p>
132+
<p><strong>WARNING</strong>: this goal is not intended to be executed directly. Instead, enable AOT with the <code>micronaut.aot.enabled</code> property, eg:</p>
133+
<pre>mvn -Dmicronaut.aot.enabled=true package</pre>
134+
<pre>mvn -Dmicronaut.aot.enabled=true mn:run</pre></p>
135+
<p><strong>Attributes</strong>:</p>
136+
<ul>
137+
<li>Requires a Maven project to be executed.</li>
138+
<li>Requires dependency resolution of artifacts in scope: <code>compile+runtime</code>.</li>
139+
<li>The goal is not marked as thread-safe and thus does not support parallel builds.</li>
140+
<li>Since version: <code>3.2.0</code>.</li></ul><section><a id="Required_Parameters"></a>
141+
<h2>Required Parameters</h2>
142+
<table class="table table-striped">
143+
<tr class="a">
144+
<th>Name</th>
145+
<th>Type</th>
146+
<th>Since</th>
147+
<th>Description</th></tr>
148+
<tr class="b">
149+
<td><a href="#baseDirectory"><code>&lt;baseDirectory&gt;</code></a></td>
150+
<td><code>File</code></td>
151+
<td><code>-</code></td>
152+
<td>The project's target directory.<br /><strong>Default</strong>: <code>${project.build.directory}</code></td></tr>
153+
<tr class="a">
154+
<td><a href="#micronautAotVersion"><code>&lt;micronautAotVersion&gt;</code></a></td>
155+
<td><code>String</code></td>
156+
<td><code>-</code></td>
157+
<td>Micronaut AOT version.<br /><strong>User Property</strong>: <code>micronaut.aot.version</code></td></tr>
158+
<tr class="b">
159+
<td><a href="#outputDirectory"><code>&lt;outputDirectory&gt;</code></a></td>
160+
<td><code>File</code></td>
161+
<td><code>-</code></td>
162+
<td>Directory where compiled application classes are.<br /><strong>Default</strong>: <code>${project.build.outputDirectory}</code></td></tr>
163+
<tr class="a">
164+
<td><a href="#runtime"><code>&lt;runtime&gt;</code></a></td>
165+
<td><code>String</code></td>
166+
<td><code>-</code></td>
167+
<td>Micronaut AOT runtime. Possible values: <code>jit</code>, <code>native</code>.<br /><strong>Default</strong>: <code>jit</code><br /><strong>User Property</strong>: <code>micronaut.aot.runtime</code></td></tr></table></section><section><a id="Optional_Parameters"></a>
168+
<h2>Optional Parameters</h2>
169+
<table class="table table-striped">
170+
<tr class="a">
171+
<th>Name</th>
172+
<th>Type</th>
173+
<th>Since</th>
174+
<th>Description</th></tr>
175+
<tr class="b">
176+
<td><a href="#aotDependencies"><code>&lt;aotDependencies&gt;</code></a></td>
177+
<td><code>List&lt;Dependency&gt;</code></td>
178+
<td><code>-</code></td>
179+
<td>No description.</td></tr>
180+
<tr class="a">
181+
<td><a href="#aotExclusions"><code>&lt;aotExclusions&gt;</code></a></td>
182+
<td><code>List&lt;Exclusion&gt;</code></td>
183+
<td><code>4.11.0</code></td>
184+
<td>Packages that would be excluded from the AOT processing.<br /><strong>User Property</strong>: <code>exclusions</code></td></tr>
185+
<tr class="b">
186+
<td><a href="#aotJvmArgs"><code>&lt;aotJvmArgs&gt;</code></a></td>
187+
<td><code>List&lt;String&gt;</code></td>
188+
<td><code>4.0.2</code></td>
189+
<td>Additional JVM arguments to pass to the AOT compiler (eg: <code>--enable-preview</code>).<br /><strong>User Property</strong>: <code>micronaut.aot.jvmArgs</code></td></tr>
190+
<tr class="a">
191+
<td><a href="#configFile"><code>&lt;configFile&gt;</code></a></td>
192+
<td><code>File</code></td>
193+
<td><code>-</code></td>
194+
<td>Micronaut AOT configuration file. Run the <code>aot-sample-config</code> goal to see all the possible options.<br /><strong>Default</strong>: <code>aot.properties</code><br /><strong>User Property</strong>: <code>micronaut.aot.config</code></td></tr>
195+
<tr class="b">
196+
<td><a href="#enabled"><code>&lt;enabled&gt;</code></a></td>
197+
<td><code>boolean</code></td>
198+
<td><code>-</code></td>
199+
<td>Whether to enable or disable Micronaut AOT.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>micronaut.aot.enabled</code></td></tr>
200+
<tr class="a">
201+
<td><a href="#packageName"><code>&lt;packageName&gt;</code></a></td>
202+
<td><code>String</code></td>
203+
<td><code>-</code></td>
204+
<td>Package name to use for generated sources.<br /><strong>User Property</strong>: <code>micronaut.aot.packageName</code></td></tr></table></section><section><a id="Parameter_Details"></a>
205+
<h2>Parameter Details</h2><a id="aotDependencies"></a><section><a id="a.3CaotDependencies.3E"></a>
206+
<h3>&lt;aotDependencies&gt;</h3>
207+
<div>No description.</div>
208+
<ul>
209+
<li><strong>Type</strong>: <code>java.util.List&lt;org.apache.maven.model.Dependency&gt;</code></li>
210+
<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a id="aotExclusions"></a><section><a id="a.3CaotExclusions.3E"></a>
211+
<h3>&lt;aotExclusions&gt;</h3>
212+
<div>Packages that would be excluded from the AOT processing.</div>
213+
<ul>
214+
<li><strong>Type</strong>: <code>java.util.List&lt;org.apache.maven.model.Exclusion&gt;</code></li>
215+
<li><strong>Since</strong>: <code>4.11.0</code></li>
216+
<li><strong>Required</strong>: <code>No</code></li>
217+
<li><strong>User Property</strong>: <code>exclusions</code></li></ul><hr /></section><a id="aotJvmArgs"></a><section><a id="a.3CaotJvmArgs.3E"></a>
218+
<h3>&lt;aotJvmArgs&gt;</h3>
219+
<div>Additional JVM arguments to pass to the AOT compiler (eg: <code>--enable-preview</code>).</div>
220+
<ul>
221+
<li><strong>Type</strong>: <code>java.util.List&lt;java.lang.String&gt;</code></li>
222+
<li><strong>Since</strong>: <code>4.0.2</code></li>
223+
<li><strong>Required</strong>: <code>No</code></li>
224+
<li><strong>User Property</strong>: <code>micronaut.aot.jvmArgs</code></li></ul><hr /></section><a id="baseDirectory"></a><section><a id="a.3CbaseDirectory.3E"></a>
225+
<h3>&lt;baseDirectory&gt;</h3>
226+
<div>The project's target directory.</div>
227+
<ul>
228+
<li><strong>Type</strong>: <code>java.io.File</code></li>
229+
<li><strong>Required</strong>: <code>Yes</code></li>
230+
<li><strong>Default</strong>: <code>${project.build.directory}</code></li></ul><hr /></section><a id="configFile"></a><section><a id="a.3CconfigFile.3E"></a>
231+
<h3>&lt;configFile&gt;</h3>
232+
<div>Micronaut AOT configuration file. Run the <code>aot-sample-config</code> goal to see all the possible options.</div>
233+
<ul>
234+
<li><strong>Type</strong>: <code>java.io.File</code></li>
235+
<li><strong>Required</strong>: <code>No</code></li>
236+
<li><strong>User Property</strong>: <code>micronaut.aot.config</code></li>
237+
<li><strong>Default</strong>: <code>aot.properties</code></li></ul><hr /></section><a id="enabled"></a><section><a id="a.3Cenabled.3E"></a>
238+
<h3>&lt;enabled&gt;</h3>
239+
<div>Whether to enable or disable Micronaut AOT.</div>
240+
<ul>
241+
<li><strong>Type</strong>: <code>boolean</code></li>
242+
<li><strong>Required</strong>: <code>No</code></li>
243+
<li><strong>User Property</strong>: <code>micronaut.aot.enabled</code></li>
244+
<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="micronautAotVersion"></a><section><a id="a.3CmicronautAotVersion.3E"></a>
245+
<h3>&lt;micronautAotVersion&gt;</h3>
246+
<div>Micronaut AOT version.</div>
247+
<ul>
248+
<li><strong>Type</strong>: <code>java.lang.String</code></li>
249+
<li><strong>Required</strong>: <code>Yes</code></li>
250+
<li><strong>User Property</strong>: <code>micronaut.aot.version</code></li></ul><hr /></section><a id="outputDirectory"></a><section><a id="a.3CoutputDirectory.3E"></a>
251+
<h3>&lt;outputDirectory&gt;</h3>
252+
<div>Directory where compiled application classes are.</div>
253+
<ul>
254+
<li><strong>Type</strong>: <code>java.io.File</code></li>
255+
<li><strong>Required</strong>: <code>Yes</code></li>
256+
<li><strong>Default</strong>: <code>${project.build.outputDirectory}</code></li></ul><hr /></section><a id="packageName"></a><section><a id="a.3CpackageName.3E"></a>
257+
<h3>&lt;packageName&gt;</h3>
258+
<div>Package name to use for generated sources.</div>
259+
<ul>
260+
<li><strong>Type</strong>: <code>java.lang.String</code></li>
261+
<li><strong>Required</strong>: <code>No</code></li>
262+
<li><strong>User Property</strong>: <code>micronaut.aot.packageName</code></li></ul><hr /></section><a id="runtime"></a><section><a id="a.3Cruntime.3E"></a>
263+
<h3>&lt;runtime&gt;</h3>
264+
<div>Micronaut AOT runtime. Possible values: <code>jit</code>, <code>native</code>.</div>
265+
<ul>
266+
<li><strong>Type</strong>: <code>java.lang.String</code></li>
267+
<li><strong>Required</strong>: <code>Yes</code></li>
268+
<li><strong>User Property</strong>: <code>micronaut.aot.runtime</code></li>
269+
<li><strong>Default</strong>: <code>jit</code></li></ul></section></section></section> </main>
270+
</div>
271+
<hr/>
272+
<footer>
273+
<div class="container">
274+
<div class="row">
275+
<p>© 2020–2026
276+
<a href="https://micronaut.io/">Micronaut</a>
277+
</p>
278+
</div>
279+
<p id="poweredBy" class="pull-right"><a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
280+
</p>
281+
</div>
282+
</footer>
283+
</body>
284+
</html>

0 commit comments

Comments
 (0)