summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorCedric Beust <cedric@beust.com>2012-01-11 13:30:02 -0800
committerCedric Beust <cedric@beust.com>2012-01-11 13:30:02 -0800
commit4dd0aec64cc5ea787e2a15246f50eb891ce3a5f5 (patch)
tree4e562b6f0cba3f286f789b986b9b5e98caef227b /doc
parentb01c46b9b0943599453c3cf2a50e0f1b2a043d3b (diff)
downloadplatform_external_jcommander-4dd0aec64cc5ea787e2a15246f50eb891ce3a5f5.tar.gz
platform_external_jcommander-4dd0aec64cc5ea787e2a15246f50eb891ce3a5f5.tar.bz2
platform_external_jcommander-4dd0aec64cc5ea787e2a15246f50eb891ce3a5f5.zip
Doc for @DynamicParameter.
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html13
1 files changed, 12 insertions, 1 deletions
diff --git a/doc/index.html b/doc/index.html
index 4b2b9eb..5d4d426 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -5,7 +5,6 @@
<link rel="stylesheet" href="testng.css" type="text/css" />
<link type="text/css" rel="stylesheet" href="http://beust.com/beust.css" />
<script type="text/javascript" src="http://beust.com/prettify.js"></script>
- <script type="text/javascript" src="http://testng.org/doc/banner.js"></script>
<script type="text/javascript" src="http://beust.com/scripts/shCore.js"></script>
<script type="text/javascript" src="http://beust.com/scripts/shBrushJava.js"></script>
@@ -676,6 +675,17 @@ Assert.assertTrue(p.isVerbose);
Assert.assertEquals(p.delegate.port, 1234);
</pre>
+<h2><a class="section" name="DynamicParameters">Dynamic parameters</a></h2>
+
+JCommander allows you to specify parameters that are not known at compile time, such as <tt>"-Da=b -Dc=d"</tt>. Such parameters are specified with the <tt><a href="apidocs/com/beust/jcommander/DynamicParameter.html">@DynamicParameter</a></tt> annotation and must be of type <tt>Map&lt;String, String&gt;</tt>. Dynamic parameters are allowed to appear multiple times on the command line:
+
+<pre class="brush: java">
+@DynamicParameter(names = "-D", description = "Dynamic parameters go here")
+public Map&lt;String, String&gt; params = Maps.newHashMap();
+</pre>
+
+You can specify a different assignment string than <tt>=</tt> by using the attribute <tt>assignment</tt>.
+
<h2><a class="section" name="Scala">JCommander in Scala</a></h2>
Here is a quick example of how to use JCommander in Scala (courtesy of Patrick Linskey):
@@ -741,5 +751,6 @@ You can download JCommander from the following locations:
</body>
<script type="text/javascript" src="http://beust.com/toc.js"></script>
+<script type="text/javascript"> generateToc(); </script>
</html>