Convert MainType to record

Author: bmalinowsky

src/io/calimero/dptxlator/TranslatorTypes.java

@@ -194,40 +194,29 @@ public final class TranslatorTypes
 	/**
 	 * Maps a data type main number to a corresponding translator class doing the DPT translations. Objects of this type
 	 * are immutable.
+	 *
+	 * @param mainNumber main number assigned to the data type
+	 * @param translator represents a translator class of type {@link DPTXlator}
+	 * @param description textual information describing this data type to a user, use {@code null} for no description
 	 */
-	public static class MainType
-	{
-		private final Class<? extends DPTXlator> xlator;
-		private final String desc;
-		private final int main;
-
-		/**
-		 * Creates a new main number to translator mapping.
-		 *
-		 * @param mainNumber main number assigned to the data type
-		 * @param translator represents a translator class of type {@link DPTXlator}
-		 * @param description textual information describing this data type to a user, use {@code null} for no
-		 *        description
-		 */
-		public MainType(final int mainNumber, final Class<? extends DPTXlator> translator, final String description)
-		{
+	public record MainType(int mainNumber, Class<? extends DPTXlator> translator, String description) {
+		public MainType {
 			if (mainNumber <= 0)
 				throw new KNXIllegalArgumentException("invalid main number");
 			if (!DPTXlator.class.isAssignableFrom(translator) || DPTXlator.class.equals(translator))
 				throw new KNXIllegalArgumentException(translator.getName() + " is not a valid DPT translator type");
-			main = mainNumber;
-			xlator = translator;
-			desc = description == null ? "" : description;
+			description = description == null ? "" : description;
 		}
 
 		/**
-		 * Returns the data type main number.
+		 * @deprecated Returns the data type main number.
 		 *
 		 * @return main number as int
 		 */
-		public final int getMainNumber()
+		@Deprecated(forRemoval = true)
+		public int getMainNumber()
 		{
-			return main;
+			return mainNumber;
 		}
 
 		/**
@@ -239,24 +228,25 @@ public final int getMainNumber()
 		 * @throws KNXFormatException to forward all target exceptions thrown in the constructor of the translator
 		 * @throws KNXException thrown on translator class creation errors (e.g. security / access problems)
 		 */
-		public final DPTXlator createTranslator(final DPT dpt) throws KNXException
+		public DPTXlator createTranslator(final DPT dpt) throws KNXException
 		{
 			return createTranslator(dpt.getID());
 		}
 
 		/**
-		 * Creates a new instance of the translator for the given datapoint type ID.
+		 * @deprecated Creates a new instance of the translator for the given datapoint type ID.
 		 *
 		 * @param dptId datapoint type ID for selecting a particular kind of value translation; if the datapoint type ID
 		 *        is not part of the translator of this main type, a {@link KNXFormatException} is thrown
 		 * @return the new {@link DPTXlator} instance
 		 * @throws KNXFormatException to forward all target exceptions thrown in the constructor of the translator
 		 * @throws KNXException thrown on translator class creation errors (e.g. security / access problems)
 		 */
+		@Deprecated(forRemoval = true)
 		public DPTXlator createTranslator(final String dptId) throws KNXException
 		{
 			try {
-				return xlator.getConstructor(String.class).newInstance(dptId);
+				return translator.getConstructor(String.class).newInstance(dptId);
 			}
 			catch (final InvocationTargetException e) {
 				// try to forward encapsulated target exception
@@ -281,12 +271,12 @@ public DPTXlator createTranslator(final String dptId) throws KNXException
 		 *        is not part of the translator of this main type, a {@link KNXFormatException} is thrown
 		 * @return the new {@link DPTXlator} instance
 		 * @throws KNXFormatException to forward all target exceptions thrown in the constructor of the translator
-		 * @throws KNXException thrown on translator class creation errors (e.g. security/access problems)
+		 * @throws KNXException thrown on translator class creation errors (e.g., security/access problems)
 		 */
 		public DPTXlator createTranslator(final DptId dptId) throws KNXException
 		{
 			try {
-				return xlator.getConstructor(String.class).newInstance(dptId.toString());
+				return translator.getConstructor(String.class).newInstance(dptId.toString());
 			}
 			catch (final InvocationTargetException e) {
 				// try to forward encapsulated target exception
@@ -305,40 +295,30 @@ public DPTXlator createTranslator(final DptId dptId) throws KNXException
 		}
 
 		/**
-		 * Returns the translator class used for this main type.
-		 * <p>
-		 *
-		 * @return the translator class as {@link Class} object
-		 */
-		public Class<? extends DPTXlator> getTranslator()
-		{
-			return xlator;
-		}
-
-		/**
-		 * Returns the description to this main type, if any.
+		 * @deprecated Returns the description to this main type, if any.
 		 * <p>
 		 *
 		 * @return description as String, or the empty string if no description set
 		 */
-		public final String getDescription()
+		@Deprecated(forRemoval = true)
+		public String getDescription()
 		{
-			return desc;
+			return description;
 		}
 
 		/**
 		 * Returns a map containing all implemented subtypes.
 		 * <p>
 		 *
 		 * @return available subtypes as {@link Map}
-		 * @throws KNXException thrown on problems accessing the translator while retrieving sub types (e.g. security /
+		 * @throws KNXException thrown on problems accessing the translator while retrieving sub types (e.g., security /
 		 *         access problem) for external, user supplied translators
 		 * @see DPTXlator#getSubTypes()
 		 */
 		public Map<String, DPT> getSubTypes() throws KNXException
 		{
 			try {
-				return subTypes(xlator);
+				return subTypes(translator);
 			}
 			catch (final Exception e) {
 				// for SecurityException and IllegalAccessException
@@ -350,7 +330,7 @@ public Map<String, DPT> getSubTypes() throws KNXException
 		@Override
 		public String toString()
 		{
-			return getDescription();
+			return description();
 		}
 	}
 
@@ -468,8 +448,8 @@ public static MainType getMainType(final int mainNumber)
 	/**
 	 * Returns all available data types which have a DPT translator implementation assigned.
 	 * <p>
-	 * The map returned is the same used by this class for type lookup. Map entries can be added, likewise entries might
-	 * be removed to change future lookup results.
+	 * The map returned is the same used by this class for type lookup. Map entries can be added or
+	 * removed to change future lookup results.
 	 *
 	 * @return a {@link Map} containing all data types as {@link MainType} objects
 	 */

test/io/calimero/dptxlator/TranslatorTypesTest.java

@@ -75,10 +75,9 @@ void getMainType() throws KNXException
 		}
 
 		for (MainType type : types) {
-			final MainType t = TranslatorTypes.getMainType(type.getMainNumber());
-			assertEquals(t.getMainNumber(), type.getMainNumber());
-			t.createTranslator(t.getSubTypes().values().iterator().next()
-					.getID());
+			final MainType t = TranslatorTypes.getMainType(type.mainNumber());
+			assertEquals(t.mainNumber(), type.mainNumber());
+			t.createTranslator(t.getSubTypes().values().iterator().next().getID());
 		}
 	}
 
@@ -154,15 +153,15 @@ void createTranslator() throws KNXException
 	{
 		// with main number
 		for (MainType mainType : types) {
-			final int main = mainType.getMainNumber();
+			final int main = mainType.mainNumber();
 			final String dptID = TranslatorTypes.getMainType(main).getSubTypes()
 					.values().iterator().next().getID();
 			TranslatorTypes.createTranslator(main, dptID);
 		}
 
 		// without main number
 		for (MainType type : types) {
-			final int main = type.getMainNumber();
+			final int main = type.mainNumber();
 			final String dptID = TranslatorTypes.getMainType(main).getSubTypes()
 					.values().iterator().next().getID();
 			TranslatorTypes.createTranslator(0, dptID);