Skip to content

Commit 239a6f4

Browse files
Converters: add more details to class docs, note default usage
1 parent 020a17f commit 239a6f4

File tree

6 files changed

+22
-14
lines changed

6 files changed

+22
-14
lines changed

objectbox-java/src/main/java/io/objectbox/converter/IntegerFlexMapConverter.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
2+
* Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
1717
package io.objectbox.converter;
1818

1919
/**
20-
* Used to automatically convert {@code Map<Integer, V>}.
20+
* A {@link FlexObjectConverter} that uses {@link Integer} as map keys.
21+
* <p>
22+
* Used by default to convert {@code Map<Integer, V>}.
2123
*/
2224
public class IntegerFlexMapConverter extends FlexObjectConverter {
2325

objectbox-java/src/main/java/io/objectbox/converter/IntegerLongMapConverter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
2+
* Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -19,9 +19,9 @@
1919
import io.objectbox.flatbuffers.FlexBuffers;
2020

2121
/**
22-
* Used to automatically convert {@code Map&lt;Integer, Long&gt;}.
22+
* Like {@link IntegerFlexMapConverter}, but always restores integer map values as {@link Long}.
2323
* <p>
24-
* Unlike {@link FlexObjectConverter} always restores integer map values as {@link Long}.
24+
* Used by default to convert {@code Map<Integer, Long>}.
2525
*/
2626
public class IntegerLongMapConverter extends IntegerFlexMapConverter {
2727
@Override

objectbox-java/src/main/java/io/objectbox/converter/LongFlexMapConverter.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
2+
* Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
1717
package io.objectbox.converter;
1818

1919
/**
20-
* Used to automatically convert {@code Map<Long, V>}.
20+
* A {@link FlexObjectConverter} that uses {@link Long} as map keys.
21+
* <p>
22+
* Used by default to convert {@code Map<Long, V>}.
2123
*/
2224
public class LongFlexMapConverter extends FlexObjectConverter {
2325

objectbox-java/src/main/java/io/objectbox/converter/LongLongMapConverter.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
2+
* Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -19,9 +19,9 @@
1919
import io.objectbox.flatbuffers.FlexBuffers;
2020

2121
/**
22-
* Used to automatically convert {@code Map&lt;Long, Long&gt;}.
22+
* Like {@link LongFlexMapConverter}, but always restores integer map values as {@link Long}.
2323
* <p>
24-
* Unlike {@link FlexObjectConverter} always restores integer map values as {@link Long}.
24+
* Used by default to convert {@code Map<Long, Long>}.
2525
*/
2626
public class LongLongMapConverter extends LongFlexMapConverter {
2727
@Override

objectbox-java/src/main/java/io/objectbox/converter/StringFlexMapConverter.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
2+
* Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
1717
package io.objectbox.converter;
1818

1919
/**
20-
* Used to automatically convert {@code Map&lt;String, V&gt;}.
20+
* A {@link FlexObjectConverter}.
21+
* <p>
22+
* Used by default to convert {@code Map<String, V>}.
2123
*/
2224
public class StringFlexMapConverter extends FlexObjectConverter {
2325
}

objectbox-java/src/main/java/io/objectbox/converter/StringLongMapConverter.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2020-2021 ObjectBox Ltd. All rights reserved.
2+
* Copyright 2020-2024 ObjectBox Ltd. All rights reserved.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -19,7 +19,9 @@
1919
import io.objectbox.flatbuffers.FlexBuffers;
2020

2121
/**
22-
* Used to automatically convert {@code Map&lt;String, Long&gt;}.
22+
* Like {@link StringFlexMapConverter}, but always restores integer map values as {@link Long}.
23+
* <p>
24+
* Used by default to convert {@code Map<String, Long>}.
2325
*/
2426
public class StringLongMapConverter extends StringFlexMapConverter {
2527
@Override

0 commit comments

Comments
 (0)