GH-1153 - Removed deprecated FormatableType.

Author: odrotbohm

spring-modulith-core/src/main/java/org/springframework/modulith/core/DependencyType.java

@@ -44,15 +44,6 @@ public enum DependencyType {
 	 */
 	USES_COMPONENT {
 
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.Module.DependencyType#format(org.springframework.modulith.model.FormatableJavaClass, org.springframework.modulith.model.FormatableJavaClass)
-		 */
-		@Override
-		public String format(FormatableType source, FormatableType target) {
-			return String.format("Component %s using %s", source.getAbbreviatedFullName(), target.getAbbreviatedFullName());
-		}
-
 		/*
 		 * (non-Javadoc)
 		 * @see org.springframework.modulith.core.DependencyType#format(org.springframework.modulith.core.FormattableType, org.springframework.modulith.core.FormattableType)
@@ -68,16 +59,6 @@ public String format(FormattableType source, FormattableType target) {
 	 */
 	ENTITY {
 
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.Module.DependencyType#format(org.springframework.modulith.model.FormatableJavaClass, org.springframework.modulith.model.FormatableJavaClass)
-		 */
-		@Override
-		public String format(FormatableType source, FormatableType target) {
-			return String.format("Entity %s depending on %s", source.getAbbreviatedFullName(),
-					target.getAbbreviatedFullName());
-		}
-
 		/*
 		 * (non-Javadoc)
 		 * @see org.springframework.modulith.core.DependencyType#format(org.springframework.modulith.core.FormattableType, org.springframework.modulith.core.FormattableType)
@@ -95,16 +76,6 @@ public String format(FormattableType source, FormattableType target) {
 	 */
 	EVENT_LISTENER {
 
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.Module.DependencyType#format(org.springframework.modulith.model.FormatableJavaClass, org.springframework.modulith.model.FormatableJavaClass)
-		 */
-		@Override
-		public String format(FormatableType source, FormatableType target) {
-			return String.format("%s listening to events of type %s", source.getAbbreviatedFullName(),
-					target.getAbbreviatedFullName());
-		}
-
 		/*
 		 * (non-Javadoc)
 		 * @see org.springframework.modulith.core.DependencyType#format(org.springframework.modulith.core.FormattableType, org.springframework.modulith.core.FormattableType)
@@ -127,15 +98,6 @@ public DependencyType defaultOr(Supplier<DependencyType> supplier) {
 			return supplier.get();
 		}
 
-		/*
-		 * (non-Javadoc)
-		 * @see org.springframework.modulith.model.Module.DependencyType#format(org.springframework.modulith.model.FormatableJavaClass, org.springframework.modulith.model.FormatableJavaClass)
-		 */
-		@Override
-		public String format(FormatableType source, FormatableType target) {
-			return String.format("%s depending on %s", source.getAbbreviatedFullName(), target.getAbbreviatedFullName());
-		}
-
 		/*
 		 * (non-Javadoc)
 		 * @see org.springframework.modulith.core.DependencyType#format(org.springframework.modulith.core.FormattableType, org.springframework.modulith.core.FormattableType)
@@ -175,12 +137,6 @@ static DependencyType forDependency(Dependency dependency) {
 		return forParameter(dependency.getTargetClass());
 	}
 
-	/**
-	 * @deprecated since 1.3, prefer {@link #format(FormattableType, FormattableType)}.
-	 */
-	@Deprecated
-	public abstract String format(FormatableType source, FormatableType target);
-
 	public abstract String format(FormattableType source, FormattableType target);
 
 	/**

spring-modulith-core/src/main/java/org/springframework/modulith/core/FormatableType.java

@@ -35,16 +35,15 @@
  *
  * @author Oliver Drotbohm
  */
-@SuppressWarnings("deprecation")
-public class FormattableType extends FormatableType {
+public class FormattableType {
 
 	private static final Map<String, FormattableType> CACHE = new ConcurrentHashMap<>();
 
 	private final String type;
 	private final Supplier<String> abbreviatedName;
 
 	/**
-	 * Creates a new {@link FormatableType} for the given source {@link String} and lazily computed abbreviated name.
+	 * Creates a new {@link FormattableType} for the given source {@link String} and lazily computed abbreviated name.
 	 *
 	 * @param type must not be {@literal null} or empty.
 	 * @param abbreviatedName must not be {@literal null}.
@@ -59,7 +58,7 @@ private FormattableType(String type, Supplier<String> abbreviatedName) {
 	}
 
 	/**
-	 * Creates a new {@link FormatableType} for the given fully-qualified type name.
+	 * Creates a new {@link FormattableType} for the given fully-qualified type name.
 	 *
 	 * @param type must not be {@literal null} or empty.
 	 */
@@ -81,7 +80,7 @@ private FormattableType(String type) {
 	}
 
 	/**
-	 * Creates a new {@link FormatableType} for the given {@link JavaClass}.
+	 * Creates a new {@link FormattableType} for the given {@link JavaClass}.
 	 *
 	 * @param type must not be {@literal null}.
 	 * @return will never be {@literal null}.
@@ -94,7 +93,7 @@ public static FormattableType of(JavaClass type) {
 	}
 
 	/**
-	 * Creates a new {@link FormatableType} for the given {@link Class}.
+	 * Creates a new {@link FormattableType} for the given {@link Class}.
 	 *
 	 * @param type must not be {@literal null}.
 	 * @return will never be {@literal null}.
@@ -119,20 +118,23 @@ public static String format(Iterable<JavaClass> types) {
 				.collect(Collectors.joining(", "));
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.modulith.core.FormatableType#getAbbreviatedFullName()
+	/**
+	 * Returns the abbreviated (i.e. every package fragment reduced to its first character) full name, e.g.
+	 * {@code com.acme.MyType} will result in {@code c.a.MyType}.
+	 *
+	 * @return will never be {@literal null}.
 	 */
-	@Override
 	public String getAbbreviatedFullName() {
 		return abbreviatedName.get();
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.modulith.core.FormatableType#getAbbreviatedFullName(org.springframework.modulith.core.ApplicationModule)
+	/**
+	 * Returns the abbreviated full name of the type abbreviating only the part of the given {@link ApplicationModule}'s
+	 * base package.
+	 *
+	 * @param module can be {@literal null}.
+	 * @return will never be {@literal null}.
 	 */
-	@Override
 	public String getAbbreviatedFullName(@Nullable ApplicationModule module) {
 
 		if (module == null) {
@@ -161,11 +163,11 @@ public String getAbbreviatedFullName(@Nullable ApplicationModule module) {
 				.concat(ClassUtils.getShortName(type));
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.springframework.modulith.core.FormatableType#getFullName()
+	/**
+	 * Returns the type's full name.
+	 *
+	 * @return will never be {@literal null}.
 	 */
-	@Override
 	public String getFullName() {
 		return type.replace("$", ".");
 	}