From 841fedafdfbf97633bb467a70241e1d04aade301 Mon Sep 17 00:00:00 2001 From: Robert von Burg Date: Wed, 13 Mar 2013 17:13:27 +0100 Subject: [PATCH] Update README.md Added information which classes exist and what they are for. Added how to build description --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/README.md b/README.md index acb872905..1ed357451 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ ch.eitchnet.java.utils ====================== Java Utilites which ease daily work when programming in the Java language + +Dependencies +---------------------- +This utility package is built by Maven3 and has very few external dependencies. The current dependencies are: +* the Java Runtime Environment 6 +* JUnit 4.10 (only during tests) +* slf4j 1.7.2 +* slf4j-log4j bindings (only during tests) + +Features +---------------------- +* RMI File client/server + * This is a small RMI client server which allows to fetch files from a server which exposes the RmiFileHandler class via RMI +* ObjectFilter + * The ObjectFilter allows to keep track of modifications to objects. The modifications are add/update/remove. + * You register the modification of an object on the filter and when all is done, you query the filter for all the add/update/remove modifications so that you only persist the required changes to your database +* ArraysHelper + * The ArraysHelper contains methods to handling arrays +* BaseEncoding + * The BaseEncoding class implements RFC4648 and thus implements Base64, Base32, Base16 in all their different alphabets and also implementes the D-Base32 encoding +* ByteHelper + * The ByteHelper contains methods to print, convert and manipulate bytes +* FileHelper + * The FileHelper contains methods relevant to files. E.g. recursively deleting directories, copying files, reading/writing files etc. +* ProcessHelper + * The ProcessHelper abstracts away OS specific process tasks +* StringHelper + * The StringHelper contains methods for handling Strings +* SystemHelper + * The SystemHelper contains methods to get system specific information +* XmlHelper + * The XmlHelper contains methods to handle XML files + +Building +------------------------- +* Prerequisites: + * JDK 6 is installed and JAVA_HOME is properly set and ../bin is in path + * Maven 3 is installed and MAVEN_HOME is properly set and ../bin is in path +* Clone repository and change path to root +* Run maven: + * mvn clean install