ygerzhedovich commented on a change in pull request #474:
URL: https://github.com/apache/ignite-3/pull/474#discussion_r766489896
##########
File path: modules/api/src/main/java/org/apache/ignite/table/mapper/Mapper.java
##########
@@ -17,60 +17,175 @@
package org.apache.ignite.table.mapper;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
+import java.lang.reflect.Modifier;
+import java.time.Instant;
+import java.time.LocalDate;
+import java.time.LocalDateTime;
+import java.time.LocalTime;
+import java.util.BitSet;
+import java.util.UUID;
/**
* Mapper interface defines methods that are required for a marshaller to map
class field names to table columns.
*
- * @param <T> Mapped type.
+ * <p>NB: Anonymous, local, inner classes, and special types are NOT
supported, and mapper will not be created for them: e.g. interfaces,
+ * annotation, and so on.
+ *
+ * @param <T> Type of which objects the mapper handles.
+ * @apiNote Implementation shouldn't use this interface directly, please, use
{@link PojoMapper} or {@link OneColumnMapper} instead.
+ * @see PojoMapper
+ * @see OneColumnMapper
*/
public interface Mapper<T> {
/**
- * Creates a mapper for a class.
+ * Shortcut method creates a mapper for class. Natively supported types
will be mapped to a single schema column, otherwise individual
+ * object fields will be mapped to columns with the same name.
+ *
+ * <p>Note: Natively supported types can be mapped to a single key/value
column, otherwise table operation will ends up with exception.
+ * Use {@link #of(Class, String)} instead, to map to a concrete column
name.
*
- * @param cls Key class.
- * @param <K> Key type.
- * @return Mapper.
+ * @param cls Target type.
+ * @return Mapper for key objects representing a single key column.
+ * @throws IllegalArgumentException If {@code cls} is of unsupported kind.
Review comment:
two suggestions from my side:
1) Maybe parameter T will be more understandable than O.
2) maybe add @param for target type?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
