-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
308 lines (289 loc) · 24.2 KB
/
index.html
File metadata and controls
308 lines (289 loc) · 24.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Argparse4j - The Java command-line argument parser library — argparse4j 0.9.0 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/default2.css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="The Argparse4j User Manual" href="usage.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="usage.html" title="The Argparse4j User Manual"
accesskey="N">next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">argparse4j 0.9.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Argparse4j - The Java command-line argument parser library</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="argparse4j-the-java-command-line-argument-parser-library">
<h1>Argparse4j - The Java command-line argument parser library<a class="headerlink" href="#argparse4j-the-java-command-line-argument-parser-library" title="Permalink to this headline">¶</a></h1>
<a class="reference external image-reference" href="https://travis-ci.com/github/argparse4j/argparse4j"><img alt="https://api.travis-ci.com/argparse4j/argparse4j.svg?branch=master" src="https://api.travis-ci.com/argparse4j/argparse4j.svg?branch=master" /></a>
<p>Argparse4j is a command line argument parser library for Java based
on Python’s
<a class="reference external" href="https://docs.python.org/3/library/argparse.html">argparse</a> module.</p>
<p>Argparse4j is available in Maven central repository:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><dependency></span>
<span class="nt"><groupId></span>net.sourceforge.argparse4j<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>argparse4j<span class="nt"></artifactId></span>
<span class="nt"><version></span>0.9.0<span class="nt"></version></span>
<span class="nt"></dependency></span>
</pre></div>
</div>
<p><strong>IMPORTANT</strong>: When upgrading, read <a class="reference external" href="https://argparse4j.github.io/migration.html">Migration</a>.
There is an important change in 0.5.0 which might break your code. The
documentation describes the change and how to migrate from earlier
versions.</p>
<p>There are still missing features which exist in argparse but not in
argparse4j, but there are also new features which only exist in
argparse4j.</p>
<p>Here is summary of features:</p>
<ul>
<li><p>Supported positional arguments and named arguments.</p></li>
<li><p>Variable number of arguments.</p></li>
<li><p>Generates well formatted line-wrapped help message.</p></li>
<li><p>Suggests named arguments/sub-command if unrecognized
arguments/sub-command were given, e.g.:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">unrecognized argument '--tpye'</span>
<span class="go">Did you mean:</span>
<span class="go"> --type</span>
</pre></div>
</div>
</li>
<li><p>Takes into account East Asian Width ambiguous characters when
line-wrap.</p></li>
<li><p>Sub-commands like, <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">add</span></code>.</p></li>
<li><p>Sub-command alias names, e.g., <code class="docutils literal notranslate"><span class="pre">co</span></code> for <code class="docutils literal notranslate"><span class="pre">checkout</span></code>.</p></li>
<li><p>Customizable option prefix characters, e.g. <code class="docutils literal notranslate"><span class="pre">+f</span></code> and <code class="docutils literal notranslate"><span class="pre">/h</span></code>.</p></li>
<li><p>Print default values in help message.</p></li>
<li><p>Choice from given collection of values.</p></li>
<li><p>Type conversion from option strings.</p></li>
<li><p>Can directly assign values into user defined classes using annotation.</p></li>
<li><p>Group arguments so that it will be printed in help message in
more readable way.</p></li>
<li><p>Mutually exclusive argument group.</p></li>
<li><p>Read additional arguments from file.</p></li>
<li><p>Argument/sub-command abbreviations.</p></li>
</ul>
<div class="section" id="requirements">
<h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
<p>Java 8 or higher is needed.</p>
<p>The main JAR contains module information for the Java Module System. The
module name is <code class="docutils literal notranslate"><span class="pre">net.sourceforge.argparse4j</span></code>.</p>
</div>
<div class="section" id="building">
<h2>Building<a class="headerlink" href="#building" title="Permalink to this headline">¶</a></h2>
<p>To build you need Java 9 or higher, and Maven 3.2.3 or higher.</p>
<p>The primary documentation is done using <a class="reference external" href="https://www.sphinx-doc.org/en/master/">Sphinx</a>. You need Sphinx to run <code class="docutils literal notranslate"><span class="pre">mvn</span> <span class="pre">site</span></code>.</p>
<p>To see how to use argparse4j, see <a class="reference internal" href="usage.html"><span class="doc">The Argparse4j User Manual</span></a>. See also
<a class="reference internal" href="examples.html"><span class="doc">Examples</span></a>.</p>
</div>
<div class="section" id="contents">
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="usage.html">The Argparse4j User Manual</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#examples">Examples</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#argumentparser-objects">ArgumentParser objects</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#the-argumentparser-addargument-method">The ArgumentParser.addArgument() method</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#the-argumentparser-parseargs-method">The ArgumentParser.parseArgs() method</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#the-namespace-object">The Namespace object</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#other-utilities">Other utilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#extensions">Extensions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#cjk-line-wrap-example">CJK line-wrap example</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#clojure-example">Clojure example</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="migration.html">Migration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="migration.html#to-0-5-0">To 0.5.0:</a></li>
<li class="toctree-l2"><a class="reference internal" href="migration.html#to-0-8-0">To 0.8.0:</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="demo">
<h2>Demo<a class="headerlink" href="#demo" title="Permalink to this headline">¶</a></h2>
<p>Here is the working demo program to calculate checksum. Argparse4j
is used to parse command line arguments (Java 7 required to compile
this source code):</p>
<div class="highlight-java notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">java.io.IOException</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">java.nio.ByteBuffer</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">java.nio.channels.ByteChannel</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">java.nio.file.Files</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">java.nio.file.Path</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">java.nio.file.Paths</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">java.nio.file.StandardOpenOption</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">java.security.MessageDigest</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">java.security.NoSuchAlgorithmException</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.argparse4j.ArgumentParsers</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.argparse4j.inf.ArgumentParser</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.argparse4j.inf.ArgumentParserException</span><span class="p">;</span>
<span class="kn">import</span> <span class="nn">net.sourceforge.argparse4j.inf.Namespace</span><span class="p">;</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Checksum</span> <span class="p">{</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kt">void</span> <span class="nf">main</span><span class="p">(</span><span class="n">String</span><span class="o">[]</span> <span class="n">args</span><span class="p">)</span> <span class="p">{</span>
<span class="n">ArgumentParser</span> <span class="n">parser</span> <span class="o">=</span> <span class="n">ArgumentParsers</span><span class="p">.</span><span class="na">newFor</span><span class="p">(</span><span class="s">"Checksum"</span><span class="p">).</span><span class="na">build</span><span class="p">()</span>
<span class="p">.</span><span class="na">defaultHelp</span><span class="p">(</span><span class="kc">true</span><span class="p">)</span>
<span class="p">.</span><span class="na">description</span><span class="p">(</span><span class="s">"Calculate checksum of given files."</span><span class="p">);</span>
<span class="n">parser</span><span class="p">.</span><span class="na">addArgument</span><span class="p">(</span><span class="s">"-t"</span><span class="p">,</span> <span class="s">"--type"</span><span class="p">)</span>
<span class="p">.</span><span class="na">choices</span><span class="p">(</span><span class="s">"SHA-256"</span><span class="p">,</span> <span class="s">"SHA-512"</span><span class="p">,</span> <span class="s">"SHA1"</span><span class="p">).</span><span class="na">setDefault</span><span class="p">(</span><span class="s">"SHA-256"</span><span class="p">)</span>
<span class="p">.</span><span class="na">help</span><span class="p">(</span><span class="s">"Specify hash function to use"</span><span class="p">);</span>
<span class="n">parser</span><span class="p">.</span><span class="na">addArgument</span><span class="p">(</span><span class="s">"file"</span><span class="p">).</span><span class="na">nargs</span><span class="p">(</span><span class="s">"*"</span><span class="p">)</span>
<span class="p">.</span><span class="na">help</span><span class="p">(</span><span class="s">"File to calculate checksum"</span><span class="p">);</span>
<span class="n">Namespace</span> <span class="n">ns</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
<span class="k">try</span> <span class="p">{</span>
<span class="n">ns</span> <span class="o">=</span> <span class="n">parser</span><span class="p">.</span><span class="na">parseArgs</span><span class="p">(</span><span class="n">args</span><span class="p">);</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">ArgumentParserException</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span>
<span class="n">parser</span><span class="p">.</span><span class="na">handleError</span><span class="p">(</span><span class="n">e</span><span class="p">);</span>
<span class="n">System</span><span class="p">.</span><span class="na">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
<span class="p">}</span>
<span class="n">MessageDigest</span> <span class="n">digest</span> <span class="o">=</span> <span class="kc">null</span><span class="p">;</span>
<span class="k">try</span> <span class="p">{</span>
<span class="n">digest</span> <span class="o">=</span> <span class="n">MessageDigest</span><span class="p">.</span><span class="na">getInstance</span><span class="p">(</span><span class="n">ns</span><span class="p">.</span><span class="na">getString</span><span class="p">(</span><span class="s">"type"</span><span class="p">));</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">NoSuchAlgorithmException</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span>
<span class="n">System</span><span class="p">.</span><span class="na">err</span><span class="p">.</span><span class="na">printf</span><span class="p">(</span><span class="s">"Could not get instance of algorithm %s: %s"</span><span class="p">,</span>
<span class="n">ns</span><span class="p">.</span><span class="na">getString</span><span class="p">(</span><span class="s">"type"</span><span class="p">),</span> <span class="n">e</span><span class="p">.</span><span class="na">getMessage</span><span class="p">());</span>
<span class="n">System</span><span class="p">.</span><span class="na">exit</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span>
<span class="p">}</span>
<span class="k">for</span> <span class="p">(</span><span class="n">String</span> <span class="n">name</span> <span class="p">:</span> <span class="n">ns</span><span class="p">.</span><span class="o"><</span><span class="n">String</span><span class="o">></span> <span class="nf">getList</span><span class="p">(</span><span class="s">"file"</span><span class="p">))</span> <span class="p">{</span>
<span class="n">Path</span> <span class="n">path</span> <span class="o">=</span> <span class="n">Paths</span><span class="p">.</span><span class="na">get</span><span class="p">(</span><span class="n">name</span><span class="p">);</span>
<span class="k">try</span> <span class="p">(</span><span class="n">ByteChannel</span> <span class="n">channel</span> <span class="o">=</span> <span class="n">Files</span><span class="p">.</span><span class="na">newByteChannel</span><span class="p">(</span><span class="n">path</span><span class="p">,</span>
<span class="n">StandardOpenOption</span><span class="p">.</span><span class="na">READ</span><span class="p">);)</span> <span class="p">{</span>
<span class="n">ByteBuffer</span> <span class="n">buffer</span> <span class="o">=</span> <span class="n">ByteBuffer</span><span class="p">.</span><span class="na">allocate</span><span class="p">(</span><span class="mi">4096</span><span class="p">);</span>
<span class="k">while</span> <span class="p">(</span><span class="n">channel</span><span class="p">.</span><span class="na">read</span><span class="p">(</span><span class="n">buffer</span><span class="p">)</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span> <span class="p">{</span>
<span class="n">buffer</span><span class="p">.</span><span class="na">flip</span><span class="p">();</span>
<span class="n">digest</span><span class="p">.</span><span class="na">update</span><span class="p">(</span><span class="n">buffer</span><span class="p">);</span>
<span class="n">buffer</span><span class="p">.</span><span class="na">clear</span><span class="p">();</span>
<span class="p">}</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">(</span><span class="n">IOException</span> <span class="n">e</span><span class="p">)</span> <span class="p">{</span>
<span class="n">System</span><span class="p">.</span><span class="na">err</span>
<span class="p">.</span><span class="na">printf</span><span class="p">(</span><span class="s">"%s: failed to read data: %s"</span><span class="p">,</span> <span class="n">e</span><span class="p">.</span><span class="na">getMessage</span><span class="p">());</span>
<span class="k">continue</span><span class="p">;</span>
<span class="p">}</span>
<span class="kt">byte</span> <span class="n">md</span><span class="o">[]</span> <span class="o">=</span> <span class="n">digest</span><span class="p">.</span><span class="na">digest</span><span class="p">();</span>
<span class="n">StringBuffer</span> <span class="n">sb</span> <span class="o">=</span> <span class="k">new</span> <span class="n">StringBuffer</span><span class="p">();</span>
<span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span> <span class="n">len</span> <span class="o">=</span> <span class="n">md</span><span class="p">.</span><span class="na">length</span><span class="p">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">len</span><span class="p">;</span> <span class="o">++</span><span class="n">i</span><span class="p">)</span> <span class="p">{</span>
<span class="n">String</span> <span class="n">x</span> <span class="o">=</span> <span class="n">Integer</span><span class="p">.</span><span class="na">toHexString</span><span class="p">(</span><span class="mh">0xff</span> <span class="o">&</span> <span class="n">md</span><span class="o">[</span><span class="n">i</span><span class="o">]</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">x</span><span class="p">.</span><span class="na">length</span><span class="p">()</span> <span class="o">==</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
<span class="n">sb</span><span class="p">.</span><span class="na">append</span><span class="p">(</span><span class="s">"0"</span><span class="p">);</span>
<span class="p">}</span>
<span class="n">sb</span><span class="p">.</span><span class="na">append</span><span class="p">(</span><span class="n">x</span><span class="p">);</span>
<span class="p">}</span>
<span class="n">System</span><span class="p">.</span><span class="na">out</span><span class="p">.</span><span class="na">printf</span><span class="p">(</span><span class="s">"%s %s\n"</span><span class="p">,</span> <span class="n">sb</span><span class="p">.</span><span class="na">toString</span><span class="p">(),</span> <span class="n">name</span><span class="p">);</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>When executed:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>java Checksum -h
<span class="go">usage: Checksum [-h] [-t {SHA-256,SHA-512,SHA1}] [file [file ...]]</span>
<span class="go">Calculate checksum of given files.</span>
<span class="go">positional arguments:</span>
<span class="go"> file File to calculate checksum</span>
<span class="go">named arguments:</span>
<span class="go"> -h, --help show this help message and exit</span>
<span class="go"> -t {SHA-256,SHA-512,SHA1}, --type {SHA-256,SHA-512,SHA1}</span>
<span class="go"> Specify hash function to use (default: SHA-256)</span>
<span class="gp">$ </span>java Checksum file1.cc file1.h
<span class="go">6bd85bf4b936bc8870c70bea04cd12d4fe3745934f511e6e188d718d32154a79 file1.cc</span>
<span class="go">839ef370cbd54f62985bac7b974cc575eaaa24a8edd6ae7787cfc71829ceda40 file1.h</span>
<span class="gp">$ </span>java Checksum --tpye file1.cc
<span class="go">usage: Checksum [-h] [-t {SHA-256,SHA-512,SHA1}] [file [file ...]]</span>
<span class="go">Checksum: error: unrecognized arguments: --tpye</span>
<span class="go">Did you mean:</span>
<span class="go"> --type</span>
<span class="gp">$ </span>java Checksum -t SHA1 file1.cc
<span class="go">20bada64dde97b98faaba09ebbfdb70af71476f1 file1.cc</span>
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper"><h3>Menu</h3>
<ul>
<li><a href="https://github.com/argparse4j/argparse4j/releases">Download</a></li>
<li><a href="http://sourceforge.net/projects/argparse4j/files/">Download (~0.5.0)</a></li>
<li><a href="https://github.com/argparse4j/argparse4j">Source Code</a></li>
<li><a href="https://github.com/argparse4j/argparse4j/issues">Issues</a></li>
<li><a href="usage.html">Usage</a></li>
<li><a href="examples.html">Examples</a></li>
<li><a href="project-info.html">Project Information</a></li>
<li><a href="apidocs/index.html">JavaDocs</a></li>
</ul>
<h3><a href="#">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Argparse4j - The Java command-line argument parser library</a><ul>
<li><a class="reference internal" href="#requirements">Requirements</a></li>
<li><a class="reference internal" href="#building">Building</a></li>
<li><a class="reference internal" href="#contents">Contents</a></li>
<li><a class="reference internal" href="#demo">Demo</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="usage.html"
title="next chapter">The Argparse4j User Manual</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="usage.html" title="The Argparse4j User Manual"
>next</a> |</li>
<li class="nav-item nav-item-0"><a href="#">argparse4j 0.9.0 documentation</a> »</li>
<li class="nav-item nav-item-this"><a href="">Argparse4j - The Java command-line argument parser library</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2011, 2015, Tatsuhiro Tsujikawa.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.1.
</div>
</body>
</html>