Skip to content

Commit a1d8505

Browse files
mkargmkarg
committed
Release 3.0
1 parent 55699da commit a1d8505

File tree

104 files changed

+2635
-434
lines changed

Some content is hidden

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

104 files changed

+2635
-434
lines changed

‎docs/apidocs/allclasses-index.html‎

Lines changed: 109 additions & 77 deletions
Large diffs are not rendered by default.

‎docs/apidocs/allclasses.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<html lang="en">
44
<head>
55
<!-- Generated by javadoc -->
6-
<title>All Classes (jcommander 2.0 API)</title>
6+
<title>All Classes (jcommander 3.0 API)</title>
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">

‎docs/apidocs/allpackages-index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<!-- Generated by javadoc (21) -->
5-
<title>All Packages (jcommander 2.1 API)</title>
5+
<title>All Packages (jcommander 3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<meta name="description" content="package index">

‎docs/apidocs/com/beust/jcommander/DefaultUsageFormatter.html‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<!-- Generated by javadoc (21) -->
5-
<title>DefaultUsageFormatter (jcommander 2.1 API)</title>
5+
<title>DefaultUsageFormatter (jcommander 3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<meta name="description" content="declaration: package: com.beust.jcommander, class: DefaultUsageFormatter">
@@ -124,8 +124,8 @@ <h2>Constructor Summary</h2>
124124
<h2>Method Summary</h2>
125125
<div id="method-summary-table">
126126
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
127-
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
128-
<div class="summary-table three-column-summary">
127+
<div id="method-summary-table.tabpanel" role="tabpanel">
128+
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
129129
<div class="table-header col-first">Modifier and Type</div>
130130
<div class="table-header col-second">Method</div>
131131
<div class="table-header col-last">Description</div>
@@ -205,18 +205,18 @@ <h2>Method Summary</h2>
205205
value of indent.</div>
206206
</div>
207207
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
208-
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#wrapDescription(java.lang.StringBuilder,int,int,java.lang.String)" class="member-name-link">wrapDescription</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;out,
208+
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#wrapDescription(java.lang.StringBuilder,int,int,java.lang.CharSequence)" class="member-name-link">wrapDescription</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;out,
209209
int&nbsp;indent,
210210
int&nbsp;currentLineIndent,
211-
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description)</code></div>
211+
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;description)</code></div>
212212
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
213213
<div class="block">Wrap a potentially long line to the value obtained by calling <a href="JCommander.html#getColumnSize()"><code>JCommander.getColumnSize()</code></a> on the
214214
underlying commander instance.</div>
215215
</div>
216216
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
217-
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#wrapDescription(java.lang.StringBuilder,int,java.lang.String)" class="member-name-link">wrapDescription</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;out,
217+
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#wrapDescription(java.lang.StringBuilder,int,java.lang.CharSequence)" class="member-name-link">wrapDescription</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;out,
218218
int&nbsp;indent,
219-
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description)</code></div>
219+
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;description)</code></div>
220220
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
221221
<div class="block">Wrap a potentially long line to { @link #commander#getColumnSize()}.</div>
222222
</div>
@@ -395,12 +395,12 @@ <h3>getCommandDescription</h3>
395395
</section>
396396
</li>
397397
<li>
398-
<section class="detail" id="wrapDescription(java.lang.StringBuilder,int,int,java.lang.String)">
398+
<section class="detail" id="wrapDescription(java.lang.StringBuilder,int,int,java.lang.CharSequence)">
399399
<h3>wrapDescription</h3>
400400
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">wrapDescription</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;out,
401401
int&nbsp;indent,
402402
int&nbsp;currentLineIndent,
403-
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description)</span></div>
403+
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;description)</span></div>
404404
<div class="block">Wrap a potentially long line to the value obtained by calling <a href="JCommander.html#getColumnSize()"><code>JCommander.getColumnSize()</code></a> on the
405405
underlying commander instance.</div>
406406
<dl class="notes">
@@ -415,11 +415,11 @@ <h3>wrapDescription</h3>
415415
</section>
416416
</li>
417417
<li>
418-
<section class="detail" id="wrapDescription(java.lang.StringBuilder,int,java.lang.String)">
418+
<section class="detail" id="wrapDescription(java.lang.StringBuilder,int,java.lang.CharSequence)">
419419
<h3>wrapDescription</h3>
420420
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">wrapDescription</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/StringBuilder.html" title="class or interface in java.lang" class="external-link">StringBuilder</a>&nbsp;out,
421421
int&nbsp;indent,
422-
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;description)</span></div>
422+
<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/CharSequence.html" title="class or interface in java.lang" class="external-link">CharSequence</a>&nbsp;description)</span></div>
423423
<div class="block">Wrap a potentially long line to { @link #commander#getColumnSize()}.</div>
424424
<dl class="notes">
425425
<dt>Parameters:</dt>
@@ -431,7 +431,7 @@ <h3>wrapDescription</h3>
431431
<dt>See Also:</dt>
432432
<dd>
433433
<ul class="tag-list-long">
434-
<li><a href="#wrapDescription(java.lang.StringBuilder,int,int,java.lang.String)"><code>wrapDescription(StringBuilder, int, int, String)</code></a></li>
434+
<li><a href="#wrapDescription(java.lang.StringBuilder,int,int,java.lang.CharSequence)"><code>wrapDescription(StringBuilder, int, int, String)</code></a></li>
435435
</ul>
436436
</dd>
437437
</dl>

‎docs/apidocs/com/beust/jcommander/DynamicParameter.html‎

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<!-- Generated by javadoc (21) -->
5-
<title>DynamicParameter (jcommander 2.1 API)</title>
5+
<title>DynamicParameter (jcommander 3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<meta name="description" content="declaration: package: com.beust.jcommander, annotation type: DynamicParameter">
@@ -133,17 +133,22 @@ <h2>Optional Element Summary</h2>
133133
<div class="col-last even-row-color">
134134
<div class="block">If specified, this number will be used to order the description of this parameter when usage() is invoked.</div>
135135
</div>
136-
<div class="col-first odd-row-color"><code>boolean</code></div>
137-
<div class="col-second odd-row-color"><code><a href="#required()" class="member-name-link">required</a></code></div>
136+
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
137+
<div class="col-second odd-row-color"><code><a href="#placeholder()" class="member-name-link">placeholder</a></code></div>
138138
<div class="col-last odd-row-color">
139+
<div class="block">If specified, the placeholder (e.g.</div>
140+
</div>
141+
<div class="col-first even-row-color"><code>boolean</code></div>
142+
<div class="col-second even-row-color"><code><a href="#required()" class="member-name-link">required</a></code></div>
143+
<div class="col-last even-row-color">
139144
<div class="block">Whether this option is required.</div>
140145
</div>
141-
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="IValueValidator.html" title="interface in com.beust.jcommander">IValueValidator</a>&gt;[]</code></div>
142-
<div class="col-second even-row-color"><code><a href="#validateValueWith()" class="member-name-link">validateValueWith</a></code></div>
143-
<div class="col-last even-row-color">&nbsp;</div>
144-
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="IParameterValidator.html" title="interface in com.beust.jcommander">IParameterValidator</a>&gt;[]</code></div>
145-
<div class="col-second odd-row-color"><code><a href="#validateWith()" class="member-name-link">validateWith</a></code></div>
146-
<div class="col-last odd-row-color">
146+
<div class="col-first odd-row-color"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="IValueValidator.html" title="interface in com.beust.jcommander">IValueValidator</a>&gt;[]</code></div>
147+
<div class="col-second odd-row-color"><code><a href="#validateValueWith()" class="member-name-link">validateValueWith</a></code></div>
148+
<div class="col-last odd-row-color">&nbsp;</div>
149+
<div class="col-first even-row-color"><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;? extends <a href="IParameterValidator.html" title="interface in com.beust.jcommander">IParameterValidator</a>&gt;[]</code></div>
150+
<div class="col-second even-row-color"><code><a href="#validateWith()" class="member-name-link">validateWith</a></code></div>
151+
<div class="col-last even-row-color">
147152
<div class="block">The validation classes to use.</div>
148153
</div>
149154
</div>
@@ -274,6 +279,21 @@ <h3>category</h3>
274279
</dl>
275280
</section>
276281
</li>
282+
<li>
283+
<section class="detail" id="placeholder()">
284+
<h3>placeholder</h3>
285+
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name">placeholder</span></div>
286+
<div class="block">If specified, the placeholder (e.g. <code>"&lt;filename&gt;"</code>) will be shown in the usage() output as a required parameter after the switch (e.g. <code>-i &lt;filename&gt;</code>).</div>
287+
<dl class="notes">
288+
<dt>Returns:</dt>
289+
<dd>the placeholder</dd>
290+
</dl>
291+
<dl class="notes">
292+
<dt>Default:</dt>
293+
<dd><code>""</code></dd>
294+
</dl>
295+
</section>
296+
</li>
277297
</ul>
278298
</section>
279299
</li>

‎docs/apidocs/com/beust/jcommander/FuzzyMap.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<!-- Generated by javadoc (21) -->
5-
<title>FuzzyMap (jcommander 2.1 API)</title>
5+
<title>FuzzyMap (jcommander 3.0 API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
88
<meta name="description" content="declaration: package: com.beust.jcommander, class: FuzzyMap">
@@ -116,8 +116,8 @@ <h2>Constructor Summary</h2>
116116
<h2>Method Summary</h2>
117117
<div id="method-summary-table">
118118
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
119-
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
120-
<div class="summary-table three-column-summary">
119+
<div id="method-summary-table.tabpanel" role="tabpanel">
120+
<div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
121121
<div class="table-header col-first">Modifier and Type</div>
122122
<div class="table-header col-second">Method</div>
123123
<div class="table-header col-last">Description</div>

0 commit comments

Comments
 (0)