v1.8.2: PrettyCollections API and fixes

Author: cordisvictor

README.md

@@ -60,6 +60,11 @@ for a higher control compared to the EasyML Facade.
 
 ### Release Notes
 
+Release 1.8.2
+- feature: added EasyML.defaultConfiguration(writer, prettyCollections)
+- bugfix: PrettyCollections impl for comparators
+
+
 Release 1.8.1
 - feature: PrettyCollections option for formatting Java Collections
 - bugfix: collection impl for java.util.Collections unmodifiableSequencedCollection()

easyml/src/net/sourceforge/easyml/EasyML.java

@@ -86,7 +86,7 @@
  * objects.<br/>
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.8.1
+ * @version 1.8.2
  * @see XMLReader
  * @see XMLWriter
  * @since 1.0
@@ -290,7 +290,14 @@ private EasyML(Supplier<XmlPullParser> xmlPullParserProvider, boolean prettyColl
         }
     }
 
-    private static void defaultConfiguration(XMLWriter writer, boolean prettyCollections) {
+    /**
+     * Configures all default strategies to the given writer.
+     *
+     * @param writer            to configure
+     * @param prettyCollections true to enable pretty collections format
+     * @see PrettyCollectionsStrategies
+     */
+    public static void defaultConfiguration(XMLWriter writer, boolean prettyCollections) {
         final XMLWriter.StrategyRegistry<SimpleStrategy> simple = writer.getSimpleStrategies();
         final XMLWriter.StrategyRegistry<CompositeStrategy> composite = writer.getCompositeStrategies();
         // dtd: because of the primitives API, DTD are included by default in the writer:

easyml/src/net/sourceforge/easyml/XMLReader.java

@@ -925,7 +925,7 @@ private Object read0(Class componentType) {
                 this.decoded.put(idAttr, newed);
                 // init composite:
                 final Object inited = cs.unmarshalInit(newed, this.driver, this.context);
-                if (newed != inited) { // for features such as Java IO Serializable readResolve:
+                if (newed != inited) { // support features such as immutable objects or Serializable readResolve:
                     this.ensureSecurityPolicy(inited);
                     this.decoded.put(idAttr, inited);
                 }

easyml/src/net/sourceforge/easyml/marshalling/java/util/CollectionStrategy.java

@@ -22,6 +22,7 @@
 import net.sourceforge.easyml.marshalling.*;
 
 import java.util.Collection;
+import java.util.function.Function;
 
 /**
  * CollectionStrategy abstract class that implements the
@@ -30,7 +31,7 @@
  *
  * @param <T> target collection class
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.8.1
+ * @version 1.8.2
  * @since 1.0
  */
 public abstract class CollectionStrategy<T extends Collection> extends AbstractStrategy implements CompositeStrategy<T> {
@@ -79,18 +80,31 @@ protected void marshalElements(T target, CompositeWriter writer) {
      */
     @Override
     public T unmarshalInit(T target, CompositeReader reader, UnmarshalContext ctx) throws IllegalAccessException {
+        final String endElementName = this.name();
+        final Function<CompositeReader, Object> unmarshalElement = unmarshalElement(target, reader, ctx);
         // consume root element:
         reader.next();
         // read elements:
-        final String endElementName = this.name();
         while (true) {
             if (reader.atElementEnd() && reader.elementName().equals(endElementName)) {
                 return target;
             }
-            final Object element = reader.read();
+            final Object element = unmarshalElement.apply(reader);
             if (!target.add(element)) {
                 throw new InvalidFormatException(ctx.readerPositionDescriptor(), "adding: " + element);
             }
         }
     }
+
+    /**
+     * Creates a function for reading an element, optionally mapping it.
+     *
+     * @param target optionally needed for mapping
+     * @param reader optionally needed for mapping
+     * @param ctx    optionally needed for mapping
+     * @return unmarshalling function
+     */
+    protected Function<CompositeReader, Object> unmarshalElement(T target, CompositeReader reader, UnmarshalContext ctx) {
+        return CompositeReader::read;
+    }
 }

easyml/src/net/sourceforge/easyml/marshalling/java/util/EnumMapStrategy.java

@@ -27,13 +27,14 @@
 import java.util.EnumMap;
 import java.util.Map;
 import java.util.Set;
+import java.util.function.Function;
 
 /**
  * EnumMapStrategy class that extends the {@linkplain MapStrategy} for
  * the {@linkplain EnumMap}. This implementation is thread-safe.
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.8.1
+ * @version 1.8.2
  * @since 1.4.6
  */
 public final class EnumMapStrategy extends MapStrategy<EnumMap> {
@@ -94,25 +95,13 @@ public EnumMap unmarshalNew(CompositeReader reader, UnmarshalContext ctx) throws
     }
 
     @Override
-    public EnumMap unmarshalInit(EnumMap target, CompositeReader reader, UnmarshalContext ctx) {
+    protected Function<CompositeReader, Object> unmarshalKey(EnumMap target, CompositeReader reader, UnmarshalContext ctx) {
         final Class keyTypeCls;
         try {
             keyTypeCls = ctx.classFor(reader.elementRequiredAttribute(ATTRIBUTE_KEYTYPE));
-        } catch (ClassNotFoundException e) {
-            throw new InvalidFormatException(ctx.readerPositionDescriptor(), "invalid " + ATTRIBUTE_KEYTYPE + ": " + e.getMessage());
-        }
-        // consume root element:
-        reader.next();
-        // read elements:
-        while (true) {
-            if (reader.atElementEnd() && reader.elementName().equals(EnumMapStrategy.NAME)) {
-                return target;
-            }
-            final Enum key = Enum.valueOf(keyTypeCls, reader.readString());
-            final Object value = reader.read();
-            if (target.put(key, value) != null) {
-                throw new InvalidFormatException(ctx.readerPositionDescriptor(), "duplicate key: " + key);
-            }
+        } catch (ClassNotFoundException thrownAtUnmarshalNew) {
+            throw new InvalidFormatException(ctx.readerPositionDescriptor(), "invalid " + ATTRIBUTE_KEYTYPE, thrownAtUnmarshalNew);
         }
+        return r -> Enum.valueOf(keyTypeCls, r.readString());
     }
 }

easyml/src/net/sourceforge/easyml/marshalling/java/util/EnumSetStrategy.java

@@ -18,20 +18,20 @@
  */
 package net.sourceforge.easyml.marshalling.java.util;
 
-import net.sourceforge.easyml.InvalidFormatException;
 import net.sourceforge.easyml.marshalling.CompositeReader;
 import net.sourceforge.easyml.marshalling.CompositeWriter;
 import net.sourceforge.easyml.marshalling.MarshalContext;
 import net.sourceforge.easyml.marshalling.UnmarshalContext;
 
 import java.util.EnumSet;
+import java.util.function.Function;
 
 /**
  * EnumSetStrategy class that extends the {@linkplain CollectionStrategy} for
  * the {@linkplain EnumSet}. This implementation is thread-safe.
  *
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.8.1
+ * @version 1.8.2
  * @since 1.4.6
  */
 public final class EnumSetStrategy extends CollectionStrategy<EnumSet> {
@@ -83,7 +83,7 @@ public String name() {
 
     @Override
     protected void marshalAttrs(EnumSet target, CompositeWriter writer, MarshalContext ctx) {
-        writer.setAttribute(ATTRIBUTE_ELEMENTTYPE, ctx.aliasOrNameFor(elementType(target)));
+        writer.setAttribute(ATTRIBUTE_ELEMENTTYPE, ctx.aliasOrNameFor(elementTypeOf(target)));
     }
 
     @Override
@@ -93,9 +93,10 @@ protected void marshalElements(EnumSet target, CompositeWriter writer) {
         }
     }
 
-    private static <E extends Enum<E>> Class<E> elementType(EnumSet<E> source) {
-        final EnumSet<E> nonEmptySource = source.isEmpty() ? EnumSet.complementOf(source) : source;
-        return nonEmptySource.iterator().next().getDeclaringClass();
+    private static <E extends Enum<E>> Class<E> elementTypeOf(EnumSet<E> source) {
+        return (source.isEmpty() ? EnumSet.complementOf(source) : source).iterator()
+                .next()
+                .getDeclaringClass();
     }
 
     @Override
@@ -104,19 +105,8 @@ public EnumSet unmarshalNew(CompositeReader reader, UnmarshalContext ctx) throws
     }
 
     @Override
-    public EnumSet unmarshalInit(EnumSet target, CompositeReader reader, UnmarshalContext ctx) {
-        // consume root element:
-        reader.next();
-        // read elements:
-        final Class elementTypeCls = elementType(target);
-        while (true) {
-            if (reader.atElementEnd() && reader.elementName().equals(EnumSetStrategy.NAME)) {
-                return target;
-            }
-            final String elementName = reader.readString();
-            if (!target.add(Enum.valueOf(elementTypeCls, elementName))) {
-                throw new InvalidFormatException(ctx.readerPositionDescriptor(), "adding: " + elementName);
-            }
-        }
+    protected Function<CompositeReader, Object> unmarshalElement(EnumSet target, CompositeReader reader, UnmarshalContext ctx) {
+        final Class elementTypeCls = elementTypeOf(target);
+        return r -> Enum.valueOf(elementTypeCls, r.readString());
     }
 }

easyml/src/net/sourceforge/easyml/marshalling/java/util/MapStrategy.java

@@ -23,6 +23,7 @@
 
 import java.util.Map;
 import java.util.Set;
+import java.util.function.Function;
 
 /**
  * MapStrategy abstract class that implements the {@linkplain CompositeStrategy}
@@ -31,7 +32,7 @@
  *
  * @param <T> target map class
  * @author Victor Cordis ( cordis.victor at gmail.com)
- * @version 1.8.1
+ * @version 1.8.2
  * @since 1.0
  */
 public abstract class MapStrategy<T extends Map> extends AbstractStrategy implements CompositeStrategy<T> {
@@ -82,19 +83,32 @@ protected void marshalEntrySet(T target, CompositeWriter writer) {
      */
     @Override
     public T unmarshalInit(T target, CompositeReader reader, UnmarshalContext ctx) throws IllegalAccessException {
+        final String endElementName = this.name();
+        final Function<CompositeReader, Object> unmarshalKey = unmarshalKey(target, reader, ctx);
         // consume root element:
         reader.next();
         // read entries:
-        final String endElementName = this.name();
         while (true) {
             if (reader.atElementEnd() && reader.elementName().equals(endElementName)) {
                 return target;
             }
-            final Object key = reader.read();
+            final Object key = unmarshalKey.apply(reader);
             if (target.containsKey(key)) {
                 throw new InvalidFormatException(ctx.readerPositionDescriptor(), "duplicate key: " + key);
             }
             target.put(key, reader.read());
         }
     }
+
+    /**
+     * Creates a function for reading a key, optionally mapping it.
+     *
+     * @param target optionally needed for mapping
+     * @param reader optionally needed for mapping
+     * @param ctx    optionally needed for mapping
+     * @return unmarshalling function
+     */
+    protected Function<CompositeReader, Object> unmarshalKey(T target, CompositeReader reader, UnmarshalContext ctx) {
+        return CompositeReader::read;
+    }
 }