.checkstyle

@@ -1,15 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 
-<fileset-config file-format-version="1.2.0" simple-config="true" sync-formatter="false">
-  <local-check-config name="Standard" location="checkstyle.xml" type="project" description="">
-    <property name="checkstyle.header.file" value="${basedir}/required-header.txt"/>
+<fileset-config file-format-version="1.2.0" simple-config="true" sync-formatter="true">
+  <local-check-config name="Standard" location="http://www.fuin.org/files/checkstyle-2015-09-12.xml" type="remote" description="">
     <additional-data name="protect-config-file" value="false"/>
   </local-check-config>
   <fileset name="all" enabled="true" check-config-name="Standard" local="true">
     <file-match-pattern match-pattern="." include-pattern="true"/>
   </fileset>
-  <filter name="FileTypesFilter" enabled="true">
-    <filter-data value="java"/>
-  </filter>
-  <filter name="NonSrcDirs" enabled="true"/>
 </fileset-config>

META-INF/MANIFEST.MF

@@ -6,12 +6,11 @@ Bundle-License: http://www.fsf.org/licensing/licenses/lgpl.html
 Bundle-ManifestVersion: 2
 Bundle-Name: Utils4J
 Bundle-SymbolicName: org.fuin.utils4j
-Bundle-Vendor: Future Invent Informationsmanagement GmbH, Hamburg (Germa
- ny)
-Bundle-Version: 0.9.0
-Export-Package: org.fuin.utils4j;version="0.9.0";uses:="javax.xml.bind,j
- avax.xml.bind.annotation,javax.xml.bind.annotation.adapters",org.fuin.u
- tils4j.filter;version="0.9.0",org.fuin.utils4j.fileprocessor;version="0
- .9.0"
+Bundle-Vendor: fuin.org (Germany)
+Bundle-Version: 0.9.1
+Export-Package: org.fuin.utils4j;version="0.9.1";uses:="javax.xml.bind,j
+ avax.xml.bind.annotation.adapters",org.fuin.utils4j.filter;version="0.9
+ .1",org.fuin.utils4j.fileprocessor;version="0.9.1"
 Import-Package: javax.crypto,javax.crypto.spec,javax.xml.bind,javax.xml.
- bind.annotation,javax.xml.bind.annotation.adapters
+ bind.annotation.adapters
+Require-Capability: osgi.ee;filter:="(&(osgi.ee=JavaSE)(version=1.8))"

README.md

@@ -15,175 +15,70 @@ A small Java library that contains several helpful utility classes.
 
 * * *
 
-##Examples
+##Features
 
-###ZIP directory
-Compress a complete directory and it's subdirectories with a single line of code using Utils4J
+###URL support for "classpath:" scheme
 ```Java
-// Given a local directory "mydir" on drive "c:" that contains
-// three files "x.txt", "y.txt" and "z.txt"
-File dirToZip = new File("c:/mydir");
-
-// Run the ZIP command
-Utils4J.zipDir(dirToZip, "abc/def", new File("c:/myfile1.zip"));
-// The archive will contain the following structure:
-// abc/def/x.txt
-// abc/def/y.txt
-// abc/def/z.txt
-
-// Run the ZIP command again
-Utils4J.zipDir(dirToZip, "", new File("c:/myfile2.zip"));
-// The second archive will contain the following structure:
-// x.txt
-// y.txt
-// z.txt
+URL url = Utils4J.url("classpath:org/fuin/utils4j/test.properties");
 ```
+A full example can be found here: [ClasspathURLExample.java](https://github.com/fuinorg/utils4j/blob/master/src/test/java/org/fuin/utils4j/examples/ClasspathURLExample.java)
 
-###Decompress a ZIP archive
-Decompress a zip file with a single line of code using Utils4J 
-```Java
-// ZIP archive to decompress
-File zipFile = new File("c:/myfile.zip");
-
-// Target directory
-File targetDir = new File("c:/test");
-
-// Unzip the content into the target directory
-Utils4J.unzip(zipFile, targetDir);
+###Variable resolver
+Resolves variable references in a map and prevents on cycles.
+```
+a=1
+b=${a}/2
+c=${b}/3
+```
+After calling the resolver a map is returned that has the replaced values:
+```
+a=1
+b=1/2
+c=1/2/3
 ```
+A full example can be found here: [VariableResolverExample.java](https://github.com/fuinorg/utils4j/blob/master/src/test/java/org/fuin/utils4j/examples/VariableResolverExample.java)
 
-###Tracking changes of a list
-This is a wrapper for lists that keeps track of all changes made to the list. This means adding, replacing or deleting elements is tracked - not the changes to the objects itself. It's also possible to revert (undo) all changes made to the list. A restriction is that no duplicate elements are allowed in the list. 
+###ZIP and UNZIP
+Compress and descompress a complete directory and it's subdirectories with a single line of code
 ```Java
-// Create a standard string list
-List list = new ArrayList();
-
-// Add some initial content
-list.add("one");
-list.add("two");
-list.add("three");
-
-// Wrap the list to track changes
-final ChangeTrackingUniqueList trackingList = new ChangeTrackingUniqueList(list);
-
-// Add and remove some items
-trackingList.add("four");
-trackingList.add("five");
-trackingList.remove("three");
+final File zipDir = new File(Utils4J.getTempDir(), "mydir");
+final File zipFile = new File(Utils4J.getTempDir(), "myfile1.zip");
+Utils4J.zipDir(zipDir, "abc/def", zipFile);
+Utils4J.unzip(zipFile, Utils4J.getTempDir());
+```
+A full example can be found here: [ZipDirExample.java](https://github.com/fuinorg/utils4j/blob/master/src/test/java/org/fuin/utils4j/examples/ZipDirExample.java)
 
-// Print the status
-// Output: true
-System.out.println("HAS CHANGED:");
+###Tracking changes of a list / map
+This is a wrapper for lists that keeps track of all changes made to the list. This means adding, replacing or deleting elements is tracked - not the changes to the objects itself. It's also possible to revert (undo) all changes made to the list. A restriction is that no duplicate elements are allowed in the list.
+```Java
+List<String> list = new ArrayList<>();
+ChangeTrackingUniqueList<String> trackingList = new ChangeTrackingUniqueList<>(list);
 System.out.println(trackingList.isChanged());
-System.out.println();
-
-// Print the deleted items
-// Output: "three"
-System.out.println("DELETED:");
-printList(trackingList.getDeleted());
-
-// Print the added items
-// Output: "four", "five"
-System.out.println("ADDED:");
-printList(trackingList.getAdded());
-
-// Revert all changes        
+System.out.println(trackingList.getDeleted());
+System.out.println(trackingList.getAdded());
 trackingList.revert();
-
-System.out.println("REVERTED:");
-// Output: "one", "two", "three"
-printList(trackingList);        
 ```
+A list example can be found here: [ChangeTrackingUniqueListExample.java](https://github.com/fuinorg/utils4j/blob/master/src/test/java/org/fuin/utils4j/examples/ChangeTrackingUniqueListExample.java)
+A map example can be found here: [ChangeTrackingMapExample.java](https://github.com/fuinorg/utils4j/blob/master/src/test/java/org/fuin/utils4j/examples/ChangeTrackingMapExample.java)
 
-###Tracking changes of a map
-This is a wrapper for maps that keeps track of all changes made to the map. This means adding, replacing or deleting elements is tracked - not the changes to the objects itself. It's also possible to revert (undo) all changes made to the map.
+###Easy file locking
 ```Java
-// Create a standard map
-Map map = new HashMap();
-
-// Add some initial content
-map.put("one", Integer.valueOf(1));
-map.put("two", Integer.valueOf(2));
-map.put("three", Integer.valueOf(3));
-
-// Wrap the map to track changes
-ChangeTrackingMap trackingMap = new ChangeTrackingMap(map);
-
-// Add/change/remove item
-trackingMap.put("four", Integer.valueOf(4));
-trackingMap.put("three", Integer.valueOf(10));
-trackingMap.remove("one");
-
-// Print the status
-// Output: true
-System.out.println("HAS CHANGED:");
-System.out.println(trackingMap.isChanged());
-System.out.println();
-
-// Print the added items
-// Output: "four=4"
-System.out.println("ADDED:");
-printMap(trackingMap.getAdded());
-
-// Print the changed items
-// Output: "three=3"
-System.out.println("CHANGED:");
-printMap(trackingMap.getChanged());
-
-// Print the removed items
-// Output: "one=1"
-System.out.println("REMOVED:");
-printMap(trackingMap.getRemoved());        
-
-// Revert all changes        
-trackingMap.revert();
-
-System.out.println("REVERTED:");
-// Output: "one=1", "two=2", "three=3"
-printMap(trackingMap);        
+FileLock lock = Utils4J.lockRandomAccessFile(randomAccessFile, tryLockMax, tryWaitMillis);
+try {
+   // Do something...
+} finally {
+    lock.release();
+}
 ```
+A full example can be found here: [LockFileExample.java](https://github.com/fuinorg/utils4j/blob/master/src/test/java/org/fuin/utils4j/examples/LockFileExample.java)
 
 ###Properties file preferences
 Shows the use of a directory and properties file based [Preferences API](http://docs.oracle.com/javase/7/docs/technotes/guides/preferences/) implementation. It's basically a replacement for the registry based implementation on Windows.
 ```Java
-// Create an application wide preferences directory 
-// named "config" in the current startup directory
-final File systemPrefDir = new File("./config");
-if (!systemPrefDir.exists()) {
-    systemPrefDir.mkdir();
-}
-
-// Create a user preferences directory with your 
-// applications name in the user's home directory
-final File userHomeDir = new File(System.getProperty("user.home"));
-final File userPrefDir = new File(userHomeDir, ".myapp");
-if (!userPrefDir.exists()) {
-    userPrefDir.mkdir();
-}
-
-// Set both directories as system properties
-System.setProperty(PropertiesFilePreferencesFactory.SYSTEM_PREF_DIR, 
-                   systemPrefDir.toString());
-System.setProperty(PropertiesFilePreferencesFactory.USER_PREF_DIR, 
-                   userPrefDir.toString());
-
-// Set the factory
-System.setProperty("java.util.prefs.PreferencesFactory",
-        PropertiesFilePreferencesFactory.class.getName());
-
-// Write something to the preferences
-final Preferences userPrefs = Preferences.userRoot();
-userPrefs.putInt("a", 1);
-userPrefs.put("b", "test");
-```
-A file ${user.home}/.myapp/preferences.properties will be created:
-```
-# DO NOT EDIT!
-# Created by org.fuin.utils4j.PropertiesFilePreferences
-# yyyy-MM-dd HH:mm:ss
-a=1
-b=test
+System.setProperty("java.util.prefs.PreferencesFactory",  PropertiesFilePreferencesFactory.class.getName());
+Preferences userPrefs = Preferences.userRoot();
 ```
+A full example can be found here: [PropertiesFilePreferencesFactoryExample.java](https://github.com/fuinorg/utils4j/blob/master/src/test/java/org/fuin/utils4j/examples/PropertiesFilePreferencesFactoryExample.java)
 
 * * *