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/4/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 * Library contents
  28 - Commandline Interface helper
  29   : eu.svjatoslav.commons.commandline.CLIHelper
  30
  31 - Commandline arguments parser and validator.
  32   : eu.svjatoslav.commons.commandline.parameterparser
  33
  34 - Bit input and output streams.
  35   : eu.svjatoslav.commons.data.BitInputStream
  36   : eu.svjatoslav.commons.data.BitOutputStream
  37
  38 - Slightly enhanced data input and output streams.
  39   : eu.svjatoslav.commons.data.EnhancedDataInputStream
  40   : eu.svjatoslav.commons.data.EnhancedDataOutputStream
  41
  42 - Byte array to HEX string converter.
  43   : eu.svjatoslav.commons.data.HexConverter
  44
  45 - Utility that tries to quess user desktop directory. (Quite ugly and
  46   unreliable. Better solution is needed.)
  47   : eu.svjatoslav.commons.file.CommonPathResolver
  48
  49 - File path parser.
  50   : eu.svjatoslav.commons.file.FilePathParser
  51
  52 - File IO helper.
  53   : eu.svjatoslav.commons.file.IOHelper
  54
  55 - Graphical error dialog.
  56   - Reusable graphical dialog to capture and show program exceptions
  57     and associated program call stack traceback.
  58     : eu.svjatoslav.commons.gui.dialog.ExceptionDialog
  59
  60 - Primitive and simple component to add navigation menus to the web
  61   sites.
  62   : eu.svjatoslav.commons.network.navigation
  63
  64 - String tokenizer.
  65   : eu.svjatoslav.commons.string.tokenizer
  66
  67 - Improved String, optimized for dealing with prefixes and suffixes.
  68   : eu.svjatoslav.commons.string.String2
  69
  70 - Wildcards matcher. (?, *)
  71   : eu.svjatoslav.commons.string.WildCardMatcher#match
  72
  73 * Usage
  74 Instructions to embed svjatoslav-commons in your project as a library:
  75
  76 Maven pom.xml file snippet:
  77
  78 #+BEGIN_SRC xml
  79 <dependencies>
  80     ...
  81     <dependency>
  82         <groupId>eu.svjatoslav</groupId>
  83         <artifactId>svjatoslavcommons</artifactId>
  84         <version>1.7</version>
  85     </dependency>
  86     ...
  87 </dependencies>
  88
  89
  90 <repositories>
  91     ...
  92     <repository>
  93         <id>svjatoslav.eu</id>
  94         <name>Svjatoslav repository</name>
  95         <url>http://www2.svjatoslav.eu/maven/</url>
  96     </repository>
  97     ...
  98 </repositories>
  99 #+END_SRC