CheckDuplicationProperties and PropsUtils added

Author: fugerit79

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- CheckDuplicationProperties and PropsUtils
+
 ## [8.5.9] - 2024-05-05
 
 ### Fixed

fj-core/src/main/java/org/fugerit/java/core/util/CheckDuplicationProperties.java

@@ -0,0 +1,34 @@
+package org.fugerit.java.core.util;
+
+import lombok.Getter;
+
+import java.util.*;
+
+/**
+ * Properties collecting values which where previously set.
+ *
+ * Especially useful after a <code>load()</code> or <code>loadFromXml()</code> methods to check duplications.
+ *
+ * NOTE: this object has some limitations, especially it depends on current implementation of <code>load()</code> and <code>put()</code> methods.
+ *
+ */
+public class CheckDuplicationProperties extends Properties {
+
+    private static final long serialVersionUID = 1432652578L;
+
+    @Getter
+    private Collection<Map.Entry<String, String>> duplications;
+
+    public CheckDuplicationProperties() {
+        this.duplications = new ArrayList<>();
+    }
+
+    @Override
+    public synchronized Object put(Object key, Object value) {
+        if ( this.containsKey( key ) ) {
+            duplications.add( new AbstractMap.SimpleEntry( key.toString(), this.getProperty( key.toString() ) ) );
+        }
+        return super.put( key, value );
+    }
+
+}

fj-core/src/main/java/org/fugerit/java/core/util/PropsUtils.java

@@ -0,0 +1,35 @@
+package org.fugerit.java.core.util;
+
+import org.fugerit.java.core.io.helper.StreamHelper;
+
+import java.io.IOException;
+import java.io.InputStream;
+public class PropsUtils {
+
+    private PropsUtils() {}
+
+    public static CheckDuplicationProperties findDuplicatedKeys(String path) throws IOException {
+        try ( InputStream in = StreamHelper.resolveStream( path ) ) {
+            return findDuplicatedKeys( in );
+        }
+    }
+
+    public static CheckDuplicationProperties findDuplicatedKeysFromXml(String path) throws IOException {
+        try ( InputStream in = StreamHelper.resolveStream( path ) ) {
+            return findDuplicatedKeysFromXml( in );
+        }
+    }
+
+    public static CheckDuplicationProperties  findDuplicatedKeys(InputStream in) throws IOException {
+        final CheckDuplicationProperties props = new CheckDuplicationProperties();
+        props.load( in );
+        return props;
+    }
+
+    public static CheckDuplicationProperties  findDuplicatedKeysFromXml(InputStream in) throws IOException {
+        final CheckDuplicationProperties props = new CheckDuplicationProperties();
+        props.loadFromXML( in );
+        return props;
+    }
+
+}

fj-core/src/main/resources/core/util/props_utils/duplicated_0.properties

@@ -0,0 +1,4 @@
+key1=one
+key2=two
+key3=three
+key4=four

fj-core/src/main/resources/core/util/props_utils/duplicated_0.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
+<properties>
+    <entry key="key1">one</entry>
+    <entry key="key2">two</entry>
+    <entry key="key3">three</entry>
+    <entry key="key4">four</entry>
+</properties>

fj-core/src/main/resources/core/util/props_utils/duplicated_1.properties

@@ -0,0 +1,4 @@
+key1=one
+key2=two
+key3=three
+key2=four

fj-core/src/main/resources/core/util/props_utils/duplicated_1.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
+<properties>
+    <entry key="key1">one</entry>
+    <entry key="key2">two</entry>
+    <entry key="key3">three</entry>
+    <entry key="key2">four</entry>
+</properties>

fj-core/src/test/java/test/org/fugerit/java/core/util/TestPropsUtils.java

@@ -0,0 +1,71 @@
+package test.org.fugerit.java.core.util;
+
+import lombok.extern.slf4j.Slf4j;
+import org.fugerit.java.core.util.PropsUtils;
+import org.junit.Assert;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.util.Collection;
+import java.util.Map;
+
+@Slf4j
+public class TestPropsUtils {
+
+    @Test
+    public void testDuplicated1File() throws IOException {
+        Collection<Map.Entry<String,String>> duplicated = PropsUtils.findDuplicatedKeys( "file://src/main/resources/core/util/props_utils/duplicated_1.properties" ).getDuplications();
+        log.info( "test duplicated on property file : {}", duplicated );
+        Assert.assertEquals( 1, duplicated.size() );
+    }
+
+    @Test
+    public void testDuplicated1Col() throws IOException {
+        Collection<Map.Entry<String,String>> duplicated = PropsUtils.findDuplicatedKeys( "cl://core/util/props_utils/duplicated_1.properties" ).getDuplications();
+        log.info( "test duplicated on property from class loader : {}", duplicated );
+        Assert.assertEquals( 1, duplicated.size() );
+    }
+
+    @Test
+    public void testDuplicated0File() throws IOException {
+        Collection<Map.Entry<String,String>> duplicated = PropsUtils.findDuplicatedKeys( "file://src/main/resources/core/util/props_utils/duplicated_0.properties" ).getDuplications();
+        log.info( "test no duplicated on property file : {}", duplicated );
+        Assert.assertEquals( 0, duplicated.size() );
+    }
+
+    @Test
+    public void testDuplicated0Col() throws IOException {
+        Collection<Map.Entry<String,String>> duplicated = PropsUtils.findDuplicatedKeys( "cl://core/util/props_utils/duplicated_0.properties" ).getDuplications();
+        log.info( "test no duplicated on property from class loader : {}", duplicated );
+        Assert.assertEquals( 0, duplicated.size() );
+    }
+
+    @Test
+    public void testDuplicated1FileXml() throws IOException {
+        Collection<Map.Entry<String,String>> duplicated = PropsUtils.findDuplicatedKeysFromXml( "file://src/main/resources/core/util/props_utils/duplicated_1.xml" ).getDuplications();
+        log.info( "test xml duplicated on property file : {}", duplicated );
+        Assert.assertEquals( 1, duplicated.size() );
+    }
+
+    @Test
+    public void testDuplicated1ColXml() throws IOException {
+        Collection<Map.Entry<String,String>> duplicated = PropsUtils.findDuplicatedKeysFromXml( "cl://core/util/props_utils/duplicated_1.xml" ).getDuplications();
+        log.info( "test xml duplicated on property from class loader : {}", duplicated );
+        Assert.assertEquals( 1, duplicated.size() );
+    }
+
+    @Test
+    public void testDuplicated0FileXml() throws IOException {
+        Collection<Map.Entry<String,String>> duplicated = PropsUtils.findDuplicatedKeysFromXml( "file://src/main/resources/core/util/props_utils/duplicated_0.xml" ).getDuplications();
+        log.info( "test xml no duplicated on property file : {}", duplicated );
+        Assert.assertEquals( 0, duplicated.size() );
+    }
+
+    @Test
+    public void testDuplicated0ColXml() throws IOException {
+        Collection<Map.Entry<String,String>> duplicated = PropsUtils.findDuplicatedKeysFromXml( "cl://core/util/props_utils/duplicated_0.xml" ).getDuplications();
+        log.info( "test xml no duplicated on property from class loader : {}", duplicated );
+        Assert.assertEquals( 0, duplicated.size() );
+    }
+
+}