| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.1:report at 2025-09-23 |
| | Rendered using Apache Maven Fluido Skin 2.1.0 |
| --> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1" /> |
| <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> |
| <title>apache-whisker:generate – Apache Whisker::Plugin4Maven</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" /> |
| <link rel="stylesheet" href="./css/site.css" /> |
| <link rel="stylesheet" href="./css/print.css" media="print" /> |
| <script src="./js/apache-maven-fluido-2.1.0.min.js"></script> |
| <link href="https://creadur.apache.org/font/matesc.css" type="text/css" rel="stylesheet" /> |
| </head> |
| <body> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/creadur-whisker" data-ribbon="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/"><img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" /> Apache Whisker</a></h1></div></div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2025-09-23<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 0.2-SNAPSHOT<span class="divider">|</span></li> |
| <li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li> |
| <li><a href="../../">Creadur</a><span class="divider">/</span></li> |
| <li><a href="../">Whisker</a><span class="divider">/</span></li> |
| <li><a href="index.html">Apache Whisker::Plugin4Maven</a><span class="divider">/</span></li> |
| <li class="active">apache-whisker:generate</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Overview</li> |
| <li><a href="index.html">Introduction</a></li> |
| <li><a href="plugin-info.html">Goals</a></li> |
| <li><a href="usage.html">Usage</a></li> |
| <li><a href="faq.html">FAQ</a></li> |
| <li class="nav-header">Examples</li> |
| <li><a href="examples/generation-in-5-mins.html">In 5 Minutes</a></li> |
| <li class="nav-header">Parent Project</li> |
| <li><a href="../index.html">Apache Whisker</a></li> |
| <li class="nav-header">Project Documentation</li> |
| <li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> |
| <li><a href="project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li> |
| <li class="nav-header">Apache Whisker™</li> |
| <li><a href="../index.html">Introducing Whisker</a></li> |
| <li><a href="../meta-data.html">Meta Data</a></li> |
| <li><a href="../apache-whisker-maven-plugin/index.html">Maven Plugin</a></li> |
| <li><a href="../apache-whisker-cli/index.html">Command Line</a></li> |
| <li><a href="../apidocs/index.html">Javadocs</a></li> |
| <li><a href="../xref/index.html">Source Cross-ref</a></li> |
| <li><a href="../faq.html">FAQ</a></li> |
| <li><a href="../download_whisker.cgi">Downloads</a></li> |
| <li><a href="../changes.html">Changes</a></li> |
| <li class="nav-header">Apache Creadur™</li> |
| <li><a href="../..">Creadur Project Home</a></li> |
| <li><a href="../../rat">Apache Rat</a></li> |
| <li><a href="../../tentacles">Apache Tentacles</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="nav-header">The Apache Software Foundation</li> |
| <li><a href="https://www.apache.org/foundation">About the Foundation</a></li> |
| <li><a href="https://projects.apache.org">The projects</a></li> |
| <li><a href="https://people.apache.org">The people</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html">How we work</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html#history">Our history</a></li> |
| <li><a href="https://blogs.apache.org/foundation/">News</a></li> |
| <li class="nav-header">Contribute</li> |
| <li><a href="https://www.apache.org/foundation/getinvolved.html">Get Involved</a></li> |
| <li class="nav-header">Committer Info</li> |
| <li><a href="https://www.apache.org/dev/committers.html">Committers' FAQ</a></li> |
| <li><a href="https://www.apache.org/dev/new-committers-guide.html">New Committers Guide</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-site/blob/asf-site/README.md">Howto publish this site</a></li> |
| <li><a href="https://community.apache.org/">Community</a></li> |
| <li><a href="https://www.apache.org/legal/">Legal</a></li> |
| <li><a href="https://www.apache.org/foundation/marks/">Branding</a></li> |
| <li><a href="https://www.apache.org/press/">Media Relations</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy"><img class="builtBy" src="https://maven.apache.org/images/logos/maven-feather.png" /> Maven</a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| <section><a id="apache-whisker.3Agenerate"></a> |
| <h1>apache-whisker:generate</h1> |
| <p><strong>Full name</strong>:</p> |
| <p>org.apache.creadur.whisker:apache-whisker-maven-plugin:0.2-SNAPSHOT:generate</p> |
| <p><strong>Description</strong>:</p> |
| <p>Generates licensing related materials such as LICENSE and NOTICE documents for assembled applications. The plugin is not bound to a specific lifecycle phase.</p> |
| <p><strong>Attributes</strong>:</p> |
| <ul> |
| <li>The goal is not marked as thread-safe and thus does not support parallel builds.</li></ul><section><a id="Required_Parameters"></a> |
| <h2>Required Parameters</h2> |
| <table class="table table-striped"> |
| <tr class="a"> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="#descriptor"><code><descriptor></code></a></td> |
| <td><code>File</code></td> |
| <td><code>-</code></td> |
| <td>This file contains a description of the licensing qualities of the expected contents of the assembled application.<br /><strong>User Property</strong>: <code>apacheWhiskerDescriptor</code></td></tr></table></section><section><a id="Optional_Parameters"></a> |
| <h2>Optional Parameters</h2> |
| <table class="table table-striped"> |
| <tr class="a"> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Since</th> |
| <th>Description</th></tr> |
| <tr class="b"> |
| <td><a href="#outputDirectory"><code><outputDirectory></code></a></td> |
| <td><code>File</code></td> |
| <td><code>-</code></td> |
| <td>Destination for generated materials<br /><strong>Default</strong>: <code>${project.build.directory}</code></td></tr> |
| <tr class="a"> |
| <td><a href="#outputEncoding"><code><outputEncoding></code></a></td> |
| <td><code>String</code></td> |
| <td><code>-</code></td> |
| <td>The licensing materials will be encoding thus.<br /><strong>Default</strong>: <code>${project.build.sourceEncoding}</code><br /><strong>User Property</strong>: <code>outputEncoding</code></td></tr></table></section><section><a id="Parameter_Details"></a> |
| <h2>Parameter Details</h2><a id="descriptor"></a><section><a id="a.3Cdescriptor.3E"></a> |
| <h3><descriptor></h3> |
| <div>This file contains a description of the licensing qualities of the expected contents of the assembled application.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.io.File</code></li> |
| <li><strong>Required</strong>: <code>Yes</code></li> |
| <li><strong>User Property</strong>: <code>apacheWhiskerDescriptor</code></li></ul><hr /></section><a id="outputDirectory"></a><section><a id="a.3CoutputDirectory.3E"></a> |
| <h3><outputDirectory></h3> |
| <div>Destination for generated materials</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.io.File</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>Default</strong>: <code>${project.build.directory}</code></li></ul><hr /></section><a id="outputEncoding"></a><section><a id="a.3CoutputEncoding.3E"></a> |
| <h3><outputEncoding></h3> |
| <div>The licensing materials will be encoding thus.</div> |
| <ul> |
| <li><strong>Type</strong>: <code>java.lang.String</code></li> |
| <li><strong>Required</strong>: <code>No</code></li> |
| <li><strong>User Property</strong>: <code>outputEncoding</code></li> |
| <li><strong>Default</strong>: <code>${project.build.sourceEncoding}</code></li></ul></section></section></section> </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| Copyright © 2012-2025 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache RAT, Apache Tentacles, Apache Whisker, Apache and the ASF logo are trademarks |
| of The Apache Software Foundation. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| This is user documentation, not legal advice. |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
