modernized POM
[svjatoslav_commons.git] / doc / index.html
1 <?xml version="1.0" encoding="utf-8"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
5 <head>
6 <title>Svjatoslav Commons - Java library of commonly used functions</title>
7 <!-- 2015-03-21 Sat 00:00 -->
8 <meta  http-equiv="Content-Type" content="text/html;charset=utf-8" />
9 <meta  name="generator" content="Org-mode" />
10 <meta  name="author" content="Svjatoslav Agejenko" />
11 <style type="text/css">
12  <!--/*--><![CDATA[/*><!--*/
13   .title  { text-align: center; }
14   .todo   { font-family: monospace; color: red; }
15   .done   { color: green; }
16   .tag    { background-color: #eee; font-family: monospace;
17             padding: 2px; font-size: 80%; font-weight: normal; }
18   .timestamp { color: #bebebe; }
19   .timestamp-kwd { color: #5f9ea0; }
20   .right  { margin-left: auto; margin-right: 0px;  text-align: right; }
21   .left   { margin-left: 0px;  margin-right: auto; text-align: left; }
22   .center { margin-left: auto; margin-right: auto; text-align: center; }
23   .underline { text-decoration: underline; }
24   #postamble p, #preamble p { font-size: 90%; margin: .2em; }
25   p.verse { margin-left: 3%; }
26   pre {
27     border: 1px solid #ccc;
28     box-shadow: 3px 3px 3px #eee;
29     padding: 8pt;
30     font-family: monospace;
31     overflow: auto;
32     margin: 1.2em;
33   }
34   pre.src {
35     position: relative;
36     overflow: visible;
37     padding-top: 1.2em;
38   }
39   pre.src:before {
40     display: none;
41     position: absolute;
42     background-color: white;
43     top: -10px;
44     right: 10px;
45     padding: 3px;
46     border: 1px solid black;
47   }
48   pre.src:hover:before { display: inline;}
49   pre.src-sh:before    { content: 'sh'; }
50   pre.src-bash:before  { content: 'sh'; }
51   pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
52   pre.src-R:before     { content: 'R'; }
53   pre.src-perl:before  { content: 'Perl'; }
54   pre.src-java:before  { content: 'Java'; }
55   pre.src-sql:before   { content: 'SQL'; }
56
57   table { border-collapse:collapse; }
58   caption.t-above { caption-side: top; }
59   caption.t-bottom { caption-side: bottom; }
60   td, th { vertical-align:top;  }
61   th.right  { text-align: center;  }
62   th.left   { text-align: center;   }
63   th.center { text-align: center; }
64   td.right  { text-align: right;  }
65   td.left   { text-align: left;   }
66   td.center { text-align: center; }
67   dt { font-weight: bold; }
68   .footpara:nth-child(2) { display: inline; }
69   .footpara { display: block; }
70   .footdef  { margin-bottom: 1em; }
71   .figure { padding: 1em; }
72   .figure p { text-align: center; }
73   .inlinetask {
74     padding: 10px;
75     border: 2px solid gray;
76     margin: 10px;
77     background: #ffffcc;
78   }
79   #org-div-home-and-up
80    { text-align: right; font-size: 70%; white-space: nowrap; }
81   textarea { overflow-x: auto; }
82   .linenr { font-size: smaller }
83   .code-highlighted { background-color: #ffff00; }
84   .org-info-js_info-navigation { border-style: none; }
85   #org-info-js_console-label
86     { font-size: 10px; font-weight: bold; white-space: nowrap; }
87   .org-info-js_search-highlight
88     { background-color: #ffff00; color: #000000; font-weight: bold; }
89   /*]]>*/-->
90 </style>
91 <link rel="stylesheet" type="text/css" href="http://thomasf.github.io/solarized-css/solarized-dark.min.css" />
92 <script type="text/javascript">
93 /*
94 @licstart  The following is the entire license notice for the
95 JavaScript code in this tag.
96
97 Copyright (C) 2012-2013 Free Software Foundation, Inc.
98
99 The JavaScript code in this tag is free software: you can
100 redistribute it and/or modify it under the terms of the GNU
101 General Public License (GNU GPL) as published by the Free Software
102 Foundation, either version 3 of the License, or (at your option)
103 any later version.  The code is distributed WITHOUT ANY WARRANTY;
104 without even the implied warranty of MERCHANTABILITY or FITNESS
105 FOR A PARTICULAR PURPOSE.  See the GNU GPL for more details.
106
107 As additional permission under GNU GPL version 3 section 7, you
108 may distribute non-source (e.g., minimized or compacted) forms of
109 that code without the copy of the GNU GPL normally required by
110 section 4, provided you include this license notice and a URL
111 through which recipients can access the Corresponding Source.
112
113
114 @licend  The above is the entire license notice
115 for the JavaScript code in this tag.
116 */
117 <!--/*--><![CDATA[/*><!--*/
118  function CodeHighlightOn(elem, id)
119  {
120    var target = document.getElementById(id);
121    if(null != target) {
122      elem.cacheClassElem = elem.className;
123      elem.cacheClassTarget = target.className;
124      target.className = "code-highlighted";
125      elem.className   = "code-highlighted";
126    }
127  }
128  function CodeHighlightOff(elem, id)
129  {
130    var target = document.getElementById(id);
131    if(elem.cacheClassElem)
132      elem.className = elem.cacheClassElem;
133    if(elem.cacheClassTarget)
134      target.className = elem.cacheClassTarget;
135  }
136 /*]]>*///-->
137 </script>
138 </head>
139 <body>
140 <div id="content">
141 <h1 class="title">Svjatoslav Commons - Java library of commonly used functions</h1>
142 <div id="table-of-contents">
143 <h2>Table of Contents</h2>
144 <div id="text-table-of-contents">
145 <ul>
146 <li><a href="#sec-1">1. General</a></li>
147 <li><a href="#sec-2">2. Usage</a></li>
148 </ul>
149 </div>
150 </div>
151 <hr  />
152 <ul class="org-ul">
153 <li><a href="http://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz">download latest snapshot</a>
154 </li>
155
156 <li>This program is free software; you can redistribute it and/or modify
157 it under the terms of version 3 of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public
158 License</a> or later as published by the Free Software Foundation.
159 </li>
160
161 <li>Program author:
162 <ul class="org-ul">
163 <li>Svjatoslav Agejenko
164 </li>
165 <li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
166 </li>
167 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
168 </li>
169 </ul>
170 </li>
171
172 <li><a href="http://svjatoslav.eu/programs.jsp">other applications hosted at svjatoslav.eu</a>
173 </li>
174 </ul>
175
176 <div id="outline-container-sec-1" class="outline-2">
177 <h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
178 <div class="outline-text-2" id="text-1">
179 <p>
180 Library contains:
181 </p>
182 <ul class="org-ul">
183 <li>Commandline Interface helper
184 </li>
185
186 <li>Commandline arguments parser and validator.
187 </li>
188
189 <li>Bit input and output streams.
190 </li>
191
192 <li>Slightly enhanced data input and output streams.
193 </li>
194
195 <li>Byte array to HEX string converter.
196 </li>
197
198 <li>Utility that tries to quess user desktop directory.
199 </li>
200
201 <li>File path parser.
202 </li>
203
204 <li>File IO helper.
205 </li>
206
207 <li>Graphical error dialog.
208 <ul class="org-ul">
209 <li>Reusable graphical dialog to capture and show program exceptions
210 and associated program call stack traceback.
211 </li>
212 </ul>
213 </li>
214
215 <li>Primitive and simple component to add navigation menus to the web
216 sites.
217 </li>
218
219 <li>String tokenizer.
220 </li>
221
222 <li>Improved String, optimized for dealing with prefixes and suffixes.
223 </li>
224
225 <li>Wildcards matcher. (?, *)
226 </li>
227 </ul>
228 </div>
229 </div>
230
231 <div id="outline-container-sec-2" class="outline-2">
232 <h2 id="sec-2"><span class="section-number-2">2</span> Usage</h2>
233 <div class="outline-text-2" id="text-2">
234 <p>
235 Instructions to embed svjatoslav-commons in your project as a library:
236 </p>
237
238 <p>
239 Maven pom.xml file snippet:
240 </p>
241
242 <div class="org-src-container">
243
244 <pre class="src src-xml">&lt;<span style="color: #A6E22E;">dependencies</span>&gt;
245     ...
246     &lt;<span style="color: #A6E22E;">dependency</span>&gt;
247         &lt;<span style="color: #A6E22E;">groupId</span>&gt;eu.svjatoslav&lt;/<span style="color: #A6E22E;">groupId</span>&gt;
248         &lt;<span style="color: #A6E22E;">artifactId</span>&gt;svjatoslavcommons&lt;/<span style="color: #A6E22E;">artifactId</span>&gt;
249         &lt;<span style="color: #A6E22E;">version</span>&gt;1.4&lt;/<span style="color: #A6E22E;">version</span>&gt;
250     &lt;/<span style="color: #A6E22E;">dependency</span>&gt;
251     ...
252 &lt;/<span style="color: #A6E22E;">dependencies</span>&gt;
253
254
255 &lt;<span style="color: #A6E22E;">repositories</span>&gt;
256     ...
257     &lt;<span style="color: #A6E22E;">repository</span>&gt;
258         &lt;<span style="color: #A6E22E;">id</span>&gt;svjatoslav.eu&lt;/<span style="color: #A6E22E;">id</span>&gt;
259         &lt;<span style="color: #A6E22E;">name</span>&gt;Svjatoslav repository&lt;/<span style="color: #A6E22E;">name</span>&gt;
260         &lt;<span style="color: #A6E22E;">url</span>&gt;http://www2.svjatoslav.eu/maven/&lt;/<span style="color: #A6E22E;">url</span>&gt;
261     &lt;/<span style="color: #A6E22E;">repository</span>&gt;
262     ...
263 &lt;/<span style="color: #A6E22E;">repositories</span>&gt;
264 </pre>
265 </div>
266 </div>
267 </div>
268 </div>
269 <div id="postamble" class="status">
270 <p class="author">Author: Svjatoslav Agejenko</p>
271 <p class="date">Created: 2015-03-21 Sat 00:00</p>
272 <p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 24.4.1 (<a href="http://orgmode.org">Org</a> mode 8.2.10)</p>
273 <p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
274 </div>
275 </body>
276 </html>