doc/index.org

   1 #+TITLE: Svjatoslav Commons - Java library of commonly used functions
   2
   3 * (document settings) :noexport:
   4 ** use dark style for TWBS-HTML exporter
   5 #+HTML_HEAD: <link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
   6 #+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
   7 #+HTML_HEAD: <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
   8 #+HTML_HEAD: <style type="text/css">
   9 #+HTML_HEAD:   footer {background-color: #111 !important;}
  10 #+HTML_HEAD:   pre {background-color: #111; color: #ccc;}
  11 #+HTML_HEAD: </style>
  12
  13 * General
  14 - This program is free software: released under Creative Commons Zero
  15   (CC0) license
  16
  17 - Program author:
  18   - Svjatoslav Agejenko
  19   - Homepage: https://svjatoslav.eu
  20   - Email: mailto://svjatoslav@svjatoslav.eu
  21
  22 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
  23
  24 ** Source code
  25 - [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
  26
  27 - [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=summary][Browse Git repository online]]
  28
  29 - Clone Git repository using command:
  30   : git clone https://www2.svjatoslav.eu/git/svjatoslav_commons.git
  31
  32 - See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
  33
  34 * Library contents
  35 - See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
  36
  37 - Commandline Interface helper
  38   : eu.svjatoslav.commons.commandline.CLIHelper
  39
  40 - Commandline arguments parser and validator.
  41   : eu.svjatoslav.commons.commandline.parameterparser
  42
  43 - Bit input and output streams.
  44   : eu.svjatoslav.commons.data.BitInputStream
  45   : eu.svjatoslav.commons.data.BitOutputStream
  46
  47 - Slightly enhanced data input and output streams.
  48   : eu.svjatoslav.commons.data.EnhancedDataInputStream
  49   : eu.svjatoslav.commons.data.EnhancedDataOutputStream
  50
  51 - Byte array to HEX string converter.
  52   : eu.svjatoslav.commons.data.HexConverter
  53
  54 - Utility that tries to quess user desktop directory. (Quite ugly and
  55   unreliable. Better solution is needed.)
  56   : eu.svjatoslav.commons.file.CommonPathResolver
  57
  58 - File path parser.
  59   : eu.svjatoslav.commons.file.FilePathParser
  60
  61 - File IO helper.
  62   : eu.svjatoslav.commons.file.IOHelper
  63
  64 - Graphical error dialog.
  65   - Reusable graphical dialog to capture and show program exceptions
  66     and associated program call stack traceback.
  67     : eu.svjatoslav.commons.gui.dialog.ExceptionDialog
  68
  69 - Primitive and simple component to add navigation menus to the web
  70   sites.
  71   : eu.svjatoslav.commons.network.navigation
  72
  73 - String tokenizer.
  74   : eu.svjatoslav.commons.string.tokenizer
  75
  76 - Improved String, optimized for dealing with prefixes and suffixes.
  77   : eu.svjatoslav.commons.string.String2
  78
  79 - Wildcards matcher. (?, *)
  80   : eu.svjatoslav.commons.string.WildCardMatcher#match
  81
  82 * Usage
  83 Instructions to embed svjatoslav-commons in your project as a library:
  84
  85 Maven pom.xml file snippet:
  86
  87 #+BEGIN_SRC xml
  88 <dependencies>
  89     ...
  90     <dependency>
  91         <groupId>eu.svjatoslav</groupId>
  92         <artifactId>svjatoslavcommons</artifactId>
  93         <version>1.7</version>
  94     </dependency>
  95     ...
  96 </dependencies>
  97
  98
  99 <repositories>
 100     ...
 101     <repository>
 102         <id>svjatoslav.eu</id>
 103         <name>Svjatoslav repository</name>
 104         <url>http://www2.svjatoslav.eu/maven/</url>
 105     </repository>
 106     ...
 107 </repositories>
 108 #+END_SRC