Converters: add more details to class docs, note default usage

greenrobot-team · greenrobot-team · commit 239a6f4417ae · 2024-07-03T07:24:15.000+02:00
diff --git a/objectbox-java/src/main/java/io/objectbox/converter/IntegerFlexMapConverter.java b/objectbox-java/src/main/java/io/objectbox/converter/IntegerFlexMapConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
+ * Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
 package io.objectbox.converter;
 
 /**
- * Used to automatically convert {@code Map&lt;Integer, V&gt;}.
+ * A {@link FlexObjectConverter} that uses {@link Integer} as map keys.
+ * <p>
+ * Used by default to convert {@code Map<Integer, V>}.
  */
 public class IntegerFlexMapConverter extends FlexObjectConverter {
 
diff --git a/objectbox-java/src/main/java/io/objectbox/converter/IntegerLongMapConverter.java b/objectbox-java/src/main/java/io/objectbox/converter/IntegerLongMapConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
+ * Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,9 +19,9 @@
 import io.objectbox.flatbuffers.FlexBuffers;
 
 /**
- * Used to automatically convert {@code Map&lt;Integer, Long&gt;}.
+ * Like {@link IntegerFlexMapConverter}, but always restores integer map values as {@link Long}.
  * <p>
- * Unlike {@link FlexObjectConverter} always restores integer map values as {@link Long}.
+ * Used by default to convert {@code Map<Integer, Long>}.
  */
 public class IntegerLongMapConverter extends IntegerFlexMapConverter {
     @Override
diff --git a/objectbox-java/src/main/java/io/objectbox/converter/LongFlexMapConverter.java b/objectbox-java/src/main/java/io/objectbox/converter/LongFlexMapConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
+ * Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
 package io.objectbox.converter;
 
 /**
- * Used to automatically convert {@code Map<Long, V>}.
+ * A {@link FlexObjectConverter} that uses {@link Long} as map keys.
+ * <p>
+ * Used by default to convert {@code Map<Long, V>}.
  */
 public class LongFlexMapConverter extends FlexObjectConverter {
 
diff --git a/objectbox-java/src/main/java/io/objectbox/converter/LongLongMapConverter.java b/objectbox-java/src/main/java/io/objectbox/converter/LongLongMapConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
+ * Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,9 +19,9 @@
 import io.objectbox.flatbuffers.FlexBuffers;
 
 /**
- * Used to automatically convert {@code Map&lt;Long, Long&gt;}.
+ * Like {@link LongFlexMapConverter}, but always restores integer map values as {@link Long}.
  * <p>
- * Unlike {@link FlexObjectConverter} always restores integer map values as {@link Long}.
+ * Used by default to convert {@code Map<Long, Long>}.
  */
 public class LongLongMapConverter extends LongFlexMapConverter {
     @Override
diff --git a/objectbox-java/src/main/java/io/objectbox/converter/StringFlexMapConverter.java b/objectbox-java/src/main/java/io/objectbox/converter/StringFlexMapConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
+ * Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
 package io.objectbox.converter;
 
 /**
- * Used to automatically convert {@code Map&lt;String, V&gt;}.
+ * A {@link FlexObjectConverter}.
+ * <p>
+ * Used by default to convert {@code Map<String, V>}.
  */
 public class StringFlexMapConverter extends FlexObjectConverter {
 }
diff --git a/objectbox-java/src/main/java/io/objectbox/converter/StringLongMapConverter.java b/objectbox-java/src/main/java/io/objectbox/converter/StringLongMapConverter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
+ * Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -19,7 +19,9 @@
 import io.objectbox.flatbuffers.FlexBuffers;
 
 /**
- * Used to automatically convert {@code Map&lt;String, Long&gt;}.
+ * Like {@link StringFlexMapConverter}, but always restores integer map values as {@link Long}.
+ * <p>
+ * Used by default to convert {@code Map<String, Long>}.
  */
 public class StringLongMapConverter extends StringFlexMapConverter {
     @Override
