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: you can redistribute it and/or modify
  15   it under the terms of the [[https://www.gnu.org/licenses/lgpl.html][GNU Lesser General Public License]] as
  16   published by the Free Software Foundation, either version 3 of the
  17   License, or (at your option) any later version.
  18
  19 - Program author:
  20   - Svjatoslav Agejenko
  21   - Homepage: https://svjatoslav.eu
  22   - Email: mailto://svjatoslav@svjatoslav.eu
  23
  24 - [[https://www.svjatoslav.eu/projects/][Other software projects hosted at svjatoslav.eu]]
  25
  26 ** Source code
  27 - [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=snapshot;h=HEAD;sf=tgz][Download latest snapshot in TAR GZ format]]
  28
  29 - [[https://www2.svjatoslav.eu/gitweb/?p=svjatoslav_commons.git;a=summary][Browse Git repository online]]
  30
  31 - Clone Git repository using command:
  32   : git clone https://www2.svjatoslav.eu/git/svjatoslav_commons.git
  33
  34 - See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
  35
  36 * Library contents
  37 - See [[https://www3.svjatoslav.eu/projects/svjatoslav_commons/apidocs/][JavaDoc]].
  38
  39 - Commandline Interface helper
  40   : eu.svjatoslav.commons.commandline.CLIHelper
  41
  42 - Commandline arguments parser and validator.
  43   : eu.svjatoslav.commons.commandline.parameterparser
  44
  45 - Bit input and output streams.
  46   : eu.svjatoslav.commons.data.BitInputStream
  47   : eu.svjatoslav.commons.data.BitOutputStream
  48
  49 - Slightly enhanced data input and output streams.
  50   : eu.svjatoslav.commons.data.EnhancedDataInputStream
  51   : eu.svjatoslav.commons.data.EnhancedDataOutputStream
  52
  53 - Byte array to HEX string converter.
  54   : eu.svjatoslav.commons.data.HexConverter
  55
  56 - Utility that tries to quess user desktop directory. (Quite ugly and
  57   unreliable. Better solution is needed.)
  58   : eu.svjatoslav.commons.file.CommonPathResolver
  59
  60 - File path parser.
  61   : eu.svjatoslav.commons.file.FilePathParser
  62
  63 - File IO helper.
  64   : eu.svjatoslav.commons.file.IOHelper
  65
  66 - Graphical error dialog.
  67   - Reusable graphical dialog to capture and show program exceptions
  68     and associated program call stack traceback.
  69     : eu.svjatoslav.commons.gui.dialog.ExceptionDialog
  70
  71 - Primitive and simple component to add navigation menus to the web
  72   sites.
  73   : eu.svjatoslav.commons.network.navigation
  74
  75 - String tokenizer.
  76   : eu.svjatoslav.commons.string.tokenizer
  77
  78 - Improved String, optimized for dealing with prefixes and suffixes.
  79   : eu.svjatoslav.commons.string.String2
  80
  81 - Wildcards matcher. (?, *)
  82   : eu.svjatoslav.commons.string.WildCardMatcher#match
  83
  84 * Usage
  85 Instructions to embed svjatoslav-commons in your project as a library:
  86
  87 Maven pom.xml file snippet:
  88
  89 #+BEGIN_SRC xml
  90 <dependencies>
  91     ...
  92     <dependency>
  93         <groupId>eu.svjatoslav</groupId>
  94         <artifactId>svjatoslavcommons</artifactId>
  95         <version>1.7</version>
  96     </dependency>
  97     ...
  98 </dependencies>
  99
 100
 101 <repositories>
 102     ...
 103     <repository>
 104         <id>svjatoslav.eu</id>
 105         <name>Svjatoslav repository</name>
 106         <url>http://www2.svjatoslav.eu/maven/</url>
 107     </repository>
 108     ...
 109 </repositories>
 110 #+END_SRC