Possibility to peek next value.
[svjatoslav_commons.git] / doc / index.org
1 #+TITLE: Svjatoslav Commons - Java library of commonly used functions
2
3 -----
4 - [[http://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][download latest snapshot]]
5
6 - This program is free software; you can redistribute it and/or modify
7   it under the terms of version 3 of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public
8   License]] or later as published by the Free Software Foundation.
9
10 - Program author:
11   - Svjatoslav Agejenko
12   - Homepage: http://svjatoslav.eu
13   - Email: mailto://svjatoslav@svjatoslav.eu
14
15 - [[http://www.svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
16
17 * (document settings) :noexport:
18 ** use dark style for TWBS-HTML exporter
19 #+HTML_HEAD: <link href="https://bootswatch.com/darkly/bootstrap.min.css" rel="stylesheet">
20 #+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
21 #+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
22 #+HTML_HEAD: <style type="text/css">
23 #+HTML_HEAD:   footer {background-color: #111 !important;}
24 #+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
25 #+HTML_HEAD: </style>
26
27 * General
28 Library contains:
29 - Commandline Interface helper
30
31 - Commandline arguments parser and validator.
32
33 - Bit input and output streams.
34
35 - Slightly enhanced data input and output streams.
36
37 - Byte array to HEX string converter.
38
39 - Utility that tries to quess user desktop directory.
40
41 - File path parser.
42
43 - File IO helper.
44
45 - Graphical error dialog.
46   - Reusable graphical dialog to capture and show program exceptions
47     and associated program call stack traceback.
48
49 - Primitive and simple component to add navigation menus to the web
50   sites.
51
52 - String tokenizer.
53
54 - Improved String, optimized for dealing with prefixes and suffixes.
55
56 - Wildcards matcher. (?, *)
57
58 * Usage
59 Instructions to embed svjatoslav-commons in your project as a library:
60
61 Maven pom.xml file snippet:
62
63 #+BEGIN_SRC xml
64 <dependencies>
65     ...
66     <dependency>
67         <groupId>eu.svjatoslav</groupId>
68         <artifactId>svjatoslavcommons</artifactId>
69         <version>1.5</version>
70     </dependency>
71     ...
72 </dependencies>
73
74
75 <repositories>
76     ...
77     <repository>
78         <id>svjatoslav.eu</id>
79         <name>Svjatoslav repository</name>
80         <url>http://www2.svjatoslav.eu/maven/</url>
81     </repository>
82     ...
83 </repositories>
84 #+END_SRC