doc/index.org

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