Deprecate NationalIdFactory.getNationalId(...) in favor of NationalId…

…Factory.newInstance(...)
reducktion · Jul 18, 2021 · faaea2b · faaea2b
1 parent 75662a4
commit faaea2b
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 4 deletions.
diff --git a/src/main/java/com/github/reducktion/socrates/Socrates.java b/src/main/java/com/github/reducktion/socrates/Socrates.java
@@ -22,7 +22,7 @@ public class Socrates {
      * @throws UnsupportedOperationException if the country is not supported
      */
     public boolean validateId(final String id, final Country country) {
-        final NationalId nationalId = NationalIdFactory.getNationalId(id, country);
+        final NationalId nationalId = NationalIdFactory.newInstance(id, country);
         return nationalId.isValid();
     }
 
@@ -35,7 +35,7 @@ public boolean validateId(final String id, final Country country) {
      * @throws UnsupportedOperationException if the country is not supported
      */
     public Optional<Citizen> extractCitizenFromId(final String id, final Country country) {
-        final NationalId nationalId = NationalIdFactory.getNationalId(id, country);
+        final NationalId nationalId = NationalIdFactory.newInstance(id, country);
         return nationalId.extractCitizen();
     }
 

diff --git a/src/main/java/com/github/reducktion/socrates/nationalid/NationalIdFactory.java b/src/main/java/com/github/reducktion/socrates/nationalid/NationalIdFactory.java
@@ -9,12 +9,28 @@ private NationalIdFactory() {}
     /**
      * Returns a new instance of {@link NationalId}, that is specific for the country parameter.
      *
+     * @deprecated use {@link #newInstance(String, Country)} instead
+     *
      * @param id the national id
      * @param country the {@link Country}
      * @return a new instance of {@link NationalId}
      * @throws UnsupportedOperationException if the country is not supported
+     *
      */
+    @Deprecated
     public static NationalId getNationalId(final String id, final Country country) {
+        return newInstance(id, country);
+    }
+
+    /**
+     * Returns a new instance of {@link NationalId}, that is specific for the country parameter.
+     *
+     * @param id the national id
+     * @param country the {@link Country}
+     * @return a new instance of {@link NationalId}
+     * @throws UnsupportedOperationException if the country is not supported
+     */
+    public static NationalId newInstance(final String id, final Country country) {
         switch (country) {
             case BE: return new BelgiumNationalId(id);
             case BR: return new BrazilNationalId(id);

diff --git a/src/test/java/com/github/reducktion/socrates/nationalid/NationalIdFactoryTest.java b/src/test/java/com/github/reducktion/socrates/nationalid/NationalIdFactoryTest.java
@@ -17,8 +17,8 @@ class NationalIdFactoryTest {
 
     @ParameterizedTest(name = "#{index} - Test with Argument={0},{1}")
     @MethodSource("nationalIdForCountryProvider")
-    void getNationalId_shouldReturnCorrectInstanceForCountry(final Country country, final Class clazz) {
-        final NationalId nationalId = NationalIdFactory.getNationalId(null, country);
+    void newInstance_shouldReturnCorrectInstanceForCountry(final Country country, final Class clazz) {
+        final NationalId nationalId = NationalIdFactory.newInstance(null, country);
 
         assertThat(nationalId, is(instanceOf(clazz)));
     }