+++ /dev/null
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
-<head>
-<!-- 2024-04-25 Thu 17:30 -->
-<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>
-<meta name="author" content="Svjatoslav Agejenko" />
-<meta name="generator" content="Org Mode" />
-<style>
- #content { max-width: 60em; margin: auto; }
- .title { text-align: center;
- margin-bottom: .2em; }
- .subtitle { text-align: center;
- font-size: medium;
- font-weight: bold;
- margin-top:0; }
- .todo { font-family: monospace; color: red; }
- .done { font-family: monospace; color: green; }
- .priority { font-family: monospace; color: orange; }
- .tag { background-color: #eee; font-family: monospace;
- padding: 2px; font-size: 80%; font-weight: normal; }
- .timestamp { color: #bebebe; }
- .timestamp-kwd { color: #5f9ea0; }
- .org-right { margin-left: auto; margin-right: 0px; text-align: right; }
- .org-left { margin-left: 0px; margin-right: auto; text-align: left; }
- .org-center { margin-left: auto; margin-right: auto; text-align: center; }
- .underline { text-decoration: underline; }
- #postamble p, #preamble p { font-size: 90%; margin: .2em; }
- p.verse { margin-left: 3%; }
- pre {
- border: 1px solid #e6e6e6;
- border-radius: 3px;
- background-color: #f2f2f2;
- padding: 8pt;
- font-family: monospace;
- overflow: auto;
- margin: 1.2em;
- }
- pre.src {
- position: relative;
- overflow: auto;
- }
- pre.src:before {
- display: none;
- position: absolute;
- top: -8px;
- right: 12px;
- padding: 3px;
- color: #555;
- background-color: #f2f2f299;
- }
- pre.src:hover:before { display: inline; margin-top: 14px;}
- /* Languages per Org manual */
- pre.src-asymptote:before { content: 'Asymptote'; }
- pre.src-awk:before { content: 'Awk'; }
- pre.src-authinfo::before { content: 'Authinfo'; }
- pre.src-C:before { content: 'C'; }
- /* pre.src-C++ doesn't work in CSS */
- pre.src-clojure:before { content: 'Clojure'; }
- pre.src-css:before { content: 'CSS'; }
- pre.src-D:before { content: 'D'; }
- pre.src-ditaa:before { content: 'ditaa'; }
- pre.src-dot:before { content: 'Graphviz'; }
- pre.src-calc:before { content: 'Emacs Calc'; }
- pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
- pre.src-fortran:before { content: 'Fortran'; }
- pre.src-gnuplot:before { content: 'gnuplot'; }
- pre.src-haskell:before { content: 'Haskell'; }
- pre.src-hledger:before { content: 'hledger'; }
- pre.src-java:before { content: 'Java'; }
- pre.src-js:before { content: 'Javascript'; }
- pre.src-latex:before { content: 'LaTeX'; }
- pre.src-ledger:before { content: 'Ledger'; }
- pre.src-lisp:before { content: 'Lisp'; }
- pre.src-lilypond:before { content: 'Lilypond'; }
- pre.src-lua:before { content: 'Lua'; }
- pre.src-matlab:before { content: 'MATLAB'; }
- pre.src-mscgen:before { content: 'Mscgen'; }
- pre.src-ocaml:before { content: 'Objective Caml'; }
- pre.src-octave:before { content: 'Octave'; }
- pre.src-org:before { content: 'Org mode'; }
- pre.src-oz:before { content: 'OZ'; }
- pre.src-plantuml:before { content: 'Plantuml'; }
- pre.src-processing:before { content: 'Processing.js'; }
- pre.src-python:before { content: 'Python'; }
- pre.src-R:before { content: 'R'; }
- pre.src-ruby:before { content: 'Ruby'; }
- pre.src-sass:before { content: 'Sass'; }
- pre.src-scheme:before { content: 'Scheme'; }
- pre.src-screen:before { content: 'Gnu Screen'; }
- pre.src-sed:before { content: 'Sed'; }
- pre.src-sh:before { content: 'shell'; }
- pre.src-sql:before { content: 'SQL'; }
- pre.src-sqlite:before { content: 'SQLite'; }
- /* additional languages in org.el's org-babel-load-languages alist */
- pre.src-forth:before { content: 'Forth'; }
- pre.src-io:before { content: 'IO'; }
- pre.src-J:before { content: 'J'; }
- pre.src-makefile:before { content: 'Makefile'; }
- pre.src-maxima:before { content: 'Maxima'; }
- pre.src-perl:before { content: 'Perl'; }
- pre.src-picolisp:before { content: 'Pico Lisp'; }
- pre.src-scala:before { content: 'Scala'; }
- pre.src-shell:before { content: 'Shell Script'; }
- pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
- /* additional language identifiers per "defun org-babel-execute"
- in ob-*.el */
- pre.src-cpp:before { content: 'C++'; }
- pre.src-abc:before { content: 'ABC'; }
- pre.src-coq:before { content: 'Coq'; }
- pre.src-groovy:before { content: 'Groovy'; }
- /* additional language identifiers from org-babel-shell-names in
- ob-shell.el: ob-shell is the only babel language using a lambda to put
- the execution function name together. */
- pre.src-bash:before { content: 'bash'; }
- pre.src-csh:before { content: 'csh'; }
- pre.src-ash:before { content: 'ash'; }
- pre.src-dash:before { content: 'dash'; }
- pre.src-ksh:before { content: 'ksh'; }
- pre.src-mksh:before { content: 'mksh'; }
- pre.src-posh:before { content: 'posh'; }
- /* Additional Emacs modes also supported by the LaTeX listings package */
- pre.src-ada:before { content: 'Ada'; }
- pre.src-asm:before { content: 'Assembler'; }
- pre.src-caml:before { content: 'Caml'; }
- pre.src-delphi:before { content: 'Delphi'; }
- pre.src-html:before { content: 'HTML'; }
- pre.src-idl:before { content: 'IDL'; }
- pre.src-mercury:before { content: 'Mercury'; }
- pre.src-metapost:before { content: 'MetaPost'; }
- pre.src-modula-2:before { content: 'Modula-2'; }
- pre.src-pascal:before { content: 'Pascal'; }
- pre.src-ps:before { content: 'PostScript'; }
- pre.src-prolog:before { content: 'Prolog'; }
- pre.src-simula:before { content: 'Simula'; }
- pre.src-tcl:before { content: 'tcl'; }
- pre.src-tex:before { content: 'TeX'; }
- pre.src-plain-tex:before { content: 'Plain TeX'; }
- pre.src-verilog:before { content: 'Verilog'; }
- pre.src-vhdl:before { content: 'VHDL'; }
- pre.src-xml:before { content: 'XML'; }
- pre.src-nxml:before { content: 'XML'; }
- /* add a generic configuration mode; LaTeX export needs an additional
- (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
- pre.src-conf:before { content: 'Configuration File'; }
-
- table { border-collapse:collapse; }
- caption.t-above { caption-side: top; }
- caption.t-bottom { caption-side: bottom; }
- td, th { vertical-align:top; }
- th.org-right { text-align: center; }
- th.org-left { text-align: center; }
- th.org-center { text-align: center; }
- td.org-right { text-align: right; }
- td.org-left { text-align: left; }
- td.org-center { text-align: center; }
- dt { font-weight: bold; }
- .footpara { display: inline; }
- .footdef { margin-bottom: 1em; }
- .figure { padding: 1em; }
- .figure p { text-align: center; }
- .equation-container {
- display: table;
- text-align: center;
- width: 100%;
- }
- .equation {
- vertical-align: middle;
- }
- .equation-label {
- display: table-cell;
- text-align: right;
- vertical-align: middle;
- }
- .inlinetask {
- padding: 10px;
- border: 2px solid gray;
- margin: 10px;
- background: #ffffcc;
- }
- #org-div-home-and-up
- { text-align: right; font-size: 70%; white-space: nowrap; }
- textarea { overflow-x: auto; }
- .linenr { font-size: smaller }
- .code-highlighted { background-color: #ffff00; }
- .org-info-js_info-navigation { border-style: none; }
- #org-info-js_console-label
- { font-size: 10px; font-weight: bold; white-space: nowrap; }
- .org-info-js_search-highlight
- { background-color: #ffff00; color: #000000; font-weight: bold; }
- .org-svg { }
-</style>
-<link rel="stylesheet" type="text/css" href="https://thomasf.github.io/solarized-css/solarized-dark.min.css" />
-</head>
-<body>
-<div id="content" class="content">
-<h1 class="title">CLI Helper - library to help implementing commandline interfaces</h1>
-<div id="table-of-contents" role="doc-toc">
-<h2>Table of Contents</h2>
-<div id="text-table-of-contents" role="doc-toc">
-<ul>
-<li><a href="#org9212145">1. General</a>
-<ul>
-<li><a href="#orgef4524a">1.1. Source code</a></li>
-</ul>
-</li>
-<li><a href="#org5a03d93">2. Overview</a>
-<ul>
-<li><a href="#orgbe808ef">2.1. Ask for user input</a></li>
-</ul>
-</li>
-<li><a href="#org20035ac">3. Alternatives and further reading</a></li>
-<li><a href="#org2e7a568">4. Getting the library</a></li>
-<li><a href="#orgcc45c0c">5. TODO:</a></li>
-</ul>
-</div>
-</div>
-
-<div id="outline-container-org9212145" class="outline-2">
-<h2 id="org9212145"><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
-(CC0) license</li>
-
-<li>Program author:
-<ul class="org-ul">
-<li>Svjatoslav Agejenko</li>
-<li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a></li>
-<li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a></li>
-</ul></li>
-
-<li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a></li>
-</ul>
-</div>
-
-<div id="outline-container-orgef4524a" class="outline-3">
-<h3 id="orgef4524a"><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>
-
-<li><a href="https://www2.svjatoslav.eu/gitweb/?p=cli-helper.git;a=summary">Browse Git repository online</a></li>
-
-<li><p>
-Clone Git repository using command:
-</p>
-<pre class="example">
-git clone https://www3.svjatoslav.eu/git/cli-helper.git
-</pre></li>
-
-<li>See <a href="https://www3.svjatoslav.eu/projects/cli-helper/apidocs/">JavaDoc</a></li>
-</ul>
-</div>
-</div>
-</div>
-
-<div id="outline-container-org5a03d93" class="outline-2">
-<h2 id="org5a03d93"><span class="section-number-2">2.</span> Overview</h2>
-<div class="outline-text-2" id="text-2">
-<ul class="org-ul">
-<li>See also: <a href="https://www3.svjatoslav.eu/projects/cli-helper/apidocs/">CLI Helper JavaDoc</a></li>
-</ul>
-
-<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>
-
-<p>
-Library provides following general functionalities:
-</p>
-<ul class="org-ul">
-<li><a href="#orgbe808ef">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-orgbe808ef" class="outline-3">
-<h3 id="orgbe808ef"><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-org20035ac" class="outline-2">
-<h2 id="org20035ac"><span class="section-number-2">3.</span> Alternatives and further reading</h2>
-<div class="outline-text-2" id="text-3">
-<ul class="org-ul">
-<li><a href="https://clig.dev/">Command Line Interface Guidelines</a></li>
-</ul>
-</div>
-</div>
-
-<div id="outline-container-org2e7a568" class="outline-2">
-<h2 id="org2e7a568"><span class="section-number-2">4.</span> Getting the library</h2>
-<div class="outline-text-2" id="text-4">
-<p>
-Instructions to embed svjatoslav-commons library in your project:
-</p>
-
-<p>
-Maven pom.xml file snippet:
-</p>
-
-<div class="org-src-container">
-<pre class="src src-xml"><<span style="color: #89b4fa;">dependencies</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.2</<span style="color: #89b4fa;">version</span>>
- </<span style="color: #89b4fa;">dependency</span>>
- ...
-</<span style="color: #89b4fa;">dependencies</span>>
-
-
-<<span style="color: #89b4fa;">repositories</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: #89b4fa;">repositories</span>>
-</pre>
-</div>
-</div>
-</div>
-<div id="outline-container-orgcc45c0c" class="outline-2">
-<h2 id="orgcc45c0c"><span class="section-number-2">5.</span> TODO:</h2>
-<div class="outline-text-2" id="text-5">
-<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: 2024-04-25 Thu 17:30</p>
-<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
-</div>
-</body>
-</html>
projects / cli-helper.git / commitdiff