cfb8b4b786cdadaa8777c521bd74b7c5fbbf95a7
[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://svjatoslav.eu/programs.jsp][other applications hosted at svjatoslav.eu]]
16
17 * General
18 Library contains:
19 - Commandline Interface helper
20
21 - Commandline arguments parser and validator.
22
23 - Bit input and output streams.
24
25 - Slightly enhanced data input and output streams.
26
27 - Byte array to HEX string converter.
28
29 - Utility that tries to quess user desktop directory.
30
31 - File path parser.
32
33 - File IO helper.
34
35 - Graphical error dialog.
36   - Reusable graphical dialog to capture and show program exceptions
37     and associated program call stack traceback.
38
39 - Primitive and simple component to add navigation menus to the web
40   sites.
41
42 - String tokenizer.
43
44 - Improved String, optimized for dealing with prefixes and suffixes.
45
46 - Wildcards matcher. (?, *)
47
48 * Usage
49 Instructions to embed svjatoslav-commons in your project as a library:
50
51 Maven pom.xml file snippet:
52
53 #+BEGIN_SRC xml
54 <dependencies>
55     ...
56     <dependency>
57         <groupId>eu.svjatoslav</groupId>
58         <artifactId>svjatoslavcommons</artifactId>
59         <version>1.4</version>
60     </dependency>
61     ...
62 </dependencies>
63
64
65 <repositories>
66     ...
67     <repository>
68         <id>svjatoslav.eu</id>
69         <name>Svjatoslav repository</name>
70         <url>http://www2.svjatoslav.eu/maven/</url>
71     </repository>
72     ...
73 </repositories>
74 #+END_SRC