"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
-<!-- 2022-07-13 Wed 04:24 -->
+<!-- 2023-10-29 Sun 23:27 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>CLI Helper - library to help implementing commandline interfaces</title>
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
-<li><a href="#org5be2417">1. General</a>
+<li><a href="#org427daf2">1. General</a>
<ul>
-<li><a href="#org3a8d88b">1.1. Source code</a></li>
+<li><a href="#orgaf34b18">1.1. Source code</a></li>
</ul>
</li>
-<li><a href="#org8bb96fe">2. Library contents</a></li>
-<li><a href="#org93b7ead">3. Usage</a></li>
+<li><a href="#org2d2e85d">2. Overview</a>
+<ul>
+<li><a href="#org81434cb">2.1. Ask for user input</a></li>
+</ul>
+</li>
+<li><a href="#orgcd70162">3. Getting the library</a></li>
+<li><a href="#org7b73615">4. TODO:</a></li>
</ul>
</div>
</div>
-<div id="outline-container-org5be2417" class="outline-2">
-<h2 id="org5be2417"><span class="section-number-2">1.</span> General</h2>
+<div id="outline-container-org427daf2" class="outline-2">
+<h2 id="org427daf2"><span class="section-number-2">1.</span> General</h2>
<div class="outline-text-2" id="text-1">
<ul class="org-ul">
<li>This program is free software: released under Creative Commons Zero
</ul>
</div>
-<div id="outline-container-org3a8d88b" class="outline-3">
-<h3 id="org3a8d88b"><span class="section-number-3">1.1.</span> Source code</h3>
+<div id="outline-container-orgaf34b18" class="outline-3">
+<h3 id="orgaf34b18"><span class="section-number-3">1.1.</span> Source code</h3>
<div class="outline-text-3" id="text-1-1">
<ul class="org-ul">
<li><a href="https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a></li>
</div>
</div>
-<div id="outline-container-org8bb96fe" class="outline-2">
-<h2 id="org8bb96fe"><span class="section-number-2">2.</span> Library contents</h2>
+<div id="outline-container-org2d2e85d" class="outline-2">
+<h2 id="org2d2e85d"><span class="section-number-2">2.</span> Overview</h2>
<div class="outline-text-2" id="text-2">
<ul class="org-ul">
-<li>See <a href="https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/">JavaDoc</a>.</li>
+<li>See also: <a href="https://www3.svjatoslav.eu/projects/cli-helper/apidocs/">CLI Helper JavaDoc</a></li>
+</ul>
-<li><p>
-Commandline Interface helper
+<p>
+This is library intended to facilitate creation of commandline
+applications in Java programming language. Library is packaged as an
+artifact to Maven repository. This makes it simple to add library as
+dependency to your project.
</p>
-<pre class="example">
-eu.svjatoslav.commons.cli_helper.CLIHelper
-</pre></li>
-<li><p>
-Commandline arguments parser and validator.
+<p>
+Library provides following general functionalities:
</p>
-<pre class="example">
-eu.svjatoslav.commons.cli_helper.parameter_parser
-</pre></li>
+<ul class="org-ul">
+<li><a href="#org81434cb">Asking for user input</a></li>
+<li><a href="CLI arguments processing.html#ID-46115263-ed3d-4acc-9ec5-523d7acf87b8">Commandline arguments processing</a></li>
</ul>
</div>
+
+<div id="outline-container-org81434cb" class="outline-3">
+<h3 id="org81434cb"><span class="section-number-3">2.1.</span> Ask for user input</h3>
+<div class="outline-text-3" id="text-2-1">
+<dl class="org-dl">
+<dt>askBoolean()</dt><dd>Asks the user to enter a boolean value (yes/no).</dd>
+<dt>askLong()</dt><dd>Asks the user to enter an integer.</dd>
+<dt>askString()</dt><dd>Asks the user to enter a string.</dd>
+</dl>
+</div>
+</div>
</div>
-<div id="outline-container-org93b7ead" class="outline-2">
-<h2 id="org93b7ead"><span class="section-number-2">3.</span> Usage</h2>
+<div id="outline-container-orgcd70162" class="outline-2">
+<h2 id="orgcd70162"><span class="section-number-2">3.</span> Getting the library</h2>
<div class="outline-text-2" id="text-3">
<p>
-Instructions to embed svjatoslav-commons in your project as a library:
+Instructions to embed svjatoslav-commons library in your project:
</p>
<p>
</p>
<div class="org-src-container">
-<pre class="src src-xml"><<span style="color: #A6E22E;">dependencies</span>>
+<pre class="src src-xml"><<span style="color: #89b4fa;">dependencies</span>>
...
- <<span style="color: #A6E22E;">dependency</span>>
- <<span style="color: #A6E22E;">groupId</span>>eu.svjatoslav</<span style="color: #A6E22E;">groupId</span>>
- <<span style="color: #A6E22E;">artifactId</span>>cli-helper</<span style="color: #A6E22E;">artifactId</span>>
- <<span style="color: #A6E22E;">version</span>>1.0</<span style="color: #A6E22E;">version</span>>
- </<span style="color: #A6E22E;">dependency</span>>
+ <<span style="color: #89b4fa;">dependency</span>>
+ <<span style="color: #89b4fa;">groupId</span>>eu.svjatoslav</<span style="color: #89b4fa;">groupId</span>>
+ <<span style="color: #89b4fa;">artifactId</span>>cli-helper</<span style="color: #89b4fa;">artifactId</span>>
+ <<span style="color: #89b4fa;">version</span>>1.1</<span style="color: #89b4fa;">version</span>>
+ </<span style="color: #89b4fa;">dependency</span>>
...
-</<span style="color: #A6E22E;">dependencies</span>>
+</<span style="color: #89b4fa;">dependencies</span>>
-<<span style="color: #A6E22E;">repositories</span>>
+<<span style="color: #89b4fa;">repositories</span>>
...
- <<span style="color: #A6E22E;">repository</span>>
- <<span style="color: #A6E22E;">id</span>>svjatoslav.eu</<span style="color: #A6E22E;">id</span>>
- <<span style="color: #A6E22E;">name</span>>Svjatoslav repository</<span style="color: #A6E22E;">name</span>>
- <<span style="color: #A6E22E;">url</span>>http://www3.svjatoslav.eu/maven/</<span style="color: #A6E22E;">url</span>>
- </<span style="color: #A6E22E;">repository</span>>
+ <<span style="color: #89b4fa;">repository</span>>
+ <<span style="color: #89b4fa;">id</span>>svjatoslav.eu</<span style="color: #89b4fa;">id</span>>
+ <<span style="color: #89b4fa;">name</span>>Svjatoslav repository</<span style="color: #89b4fa;">name</span>>
+ <<span style="color: #89b4fa;">url</span>>http://www3.svjatoslav.eu/maven/</<span style="color: #89b4fa;">url</span>>
+ </<span style="color: #89b4fa;">repository</span>>
...
-</<span style="color: #A6E22E;">repositories</span>>
+</<span style="color: #89b4fa;">repositories</span>>
</pre>
</div>
</div>
</div>
+<div id="outline-container-org7b73615" class="outline-2">
+<h2 id="org7b73615"><span class="section-number-2">4.</span> TODO:</h2>
+<div class="outline-text-2" id="text-4">
+<p>
+List of improvement suggestions:
+</p>
+
+<ul class="org-ul">
+<li>Add more concrete examples of how to use the library in JavaDoc
+comments. This will help developers quickly get started and learn
+the API.</li>
+
+<li>Provide more comprehensive unit tests for CliHelper,
+ParameterParser, Options and subclasses. This will ensure robustness
+and stability.</li>
+
+<li>Add JavaDoc comments to all classes and methods where
+applicable. This will provide better visibility into the library's
+functionality for developers.</li>
+
+<li>Add more option types like date/time, regular expression etc.</li>
+
+<li>Document best practices for using the library in a larger project.</li>
+
+<li>Implement support for more complex CLI applications like option
+dependencies and conflicts resolution.</li>
+</ul>
+</div>
+</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2022-07-13 Wed 04:24</p>
+<p class="date">Created: 2023-10-29 Sun 23:27</p>
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
projects / cli-helper.git / blobdiff