This is an automated email from the ASF dual-hosted git repository. amashenkov pushed a commit to branch ignite-14559 in repository https://gitbox.apache.org/repos/asf/ignite-3.git
commit ba4b81fc12a242430ba41cf19e042fd65e38c8b4 Author: Andrew Mashenkov <[email protected]> AuthorDate: Fri Apr 16 00:12:14 2021 +0300 Fix javadoc. --- .../main/java/org/apache/ignite/table/Table.java | 6 ++++ .../java/org/apache/ignite/table/TableView.java | 11 ++++++- modules/core/pom.xml | 3 -- .../ignite/internal/tostring/FieldDescriptor.java | 4 ++- .../internal/tostring/IgniteToStringBuilder.java | 1 + .../internal/tostring/IgniteToStringOrder.java | 2 ++ .../apache/ignite/internal/util/GridUnsafe.java | 2 ++ .../apache/ignite/lang/IgniteSystemProperties.java | 6 +++- .../apache/ignite/internal/schema/BinaryRow.java | 6 +++- .../org/apache/ignite/internal/schema/Columns.java | 11 +++++-- .../ignite/internal/schema/ExpandableByteBuf.java | 36 ++++++++++++++++++++-- .../apache/ignite/internal/schema/NativeType.java | 5 +++ .../ignite/internal/schema/RowAssembler.java | 6 +++- .../schema/marshaller/AbstractSerializer.java | 1 + .../internal/schema/marshaller/MarshallerUtil.java | 10 +++--- .../internal/schema/marshaller/Serializer.java | 11 +++++++ .../marshaller/reflection/FieldAccessor.java | 1 + .../org/apache/ignite/binary/BinaryObjects.java | 2 ++ .../internal/schema/marshaller/KVSerializer.java | 9 +++--- .../ignite/internal/table/AbstractTableView.java | 1 + .../apache/ignite/internal/table/TableImpl.java | 1 + 21 files changed, 113 insertions(+), 22 deletions(-) diff --git a/modules/api/src/main/java/org/apache/ignite/table/Table.java b/modules/api/src/main/java/org/apache/ignite/table/Table.java index d388297..80d7273 100644 --- a/modules/api/src/main/java/org/apache/ignite/table/Table.java +++ b/modules/api/src/main/java/org/apache/ignite/table/Table.java @@ -42,6 +42,7 @@ public interface Table extends TableView<Tuple> { * Creates record view of table for record class mapper provided. * * @param recMapper Record class mapper. + * @param <R> Record type. * @return Table record view. */ <R> RecordView<R> recordView(RecordMapper<R> recMapper); @@ -51,6 +52,8 @@ public interface Table extends TableView<Tuple> { * * @param keyMapper Key class mapper. * @param valMapper Value class mapper. + * @param <K> Key type. + * @param <V> Value type. * @return Table key-value view. */ <K, V> KeyValueView<K, V> kvView(KeyMapper<K> keyMapper, ValueMapper<V> valMapper); @@ -66,6 +69,7 @@ public interface Table extends TableView<Tuple> { * Creates record view of table for record class provided. * * @param recCls Record class. + * @param <R> Record type. * @return Table record view. */ default <R> RecordView<R> recordView(Class<R> recCls) { @@ -77,6 +81,8 @@ public interface Table extends TableView<Tuple> { * * @param keyCls Key class. * @param valCls Value class. + * @param <K> Key type. + * @param <V> Value type. * @return Table key-value view. */ default <K, V> KeyValueView<K, V> kvView(Class<K> keyCls, Class<V> valCls) { diff --git a/modules/api/src/main/java/org/apache/ignite/table/TableView.java b/modules/api/src/main/java/org/apache/ignite/table/TableView.java index bb50a08..02ac2a1 100644 --- a/modules/api/src/main/java/org/apache/ignite/table/TableView.java +++ b/modules/api/src/main/java/org/apache/ignite/table/TableView.java @@ -277,6 +277,8 @@ public interface TableView<R> { * Executes an InvokeProcessor code against a record with the same key columns values as the given one has. * * @param keyRec Record with key columns set. + * @param proc Invoke processor. + * @param <T> InvokeProcessor result type. * @return Results of the processing. */ <T extends Serializable> T invoke(R keyRec, InvokeProcessor<R, R, T> proc); @@ -286,6 +288,8 @@ public interface TableView<R> { * with the same key columns values as the given one has. * * @param keyRec Record with key columns set. + * @param proc Invoke processor. + * @param <T> InvokeProcessor result type. * @return Future representing pending completion of the operation. */ @NotNull <T extends Serializable> CompletableFuture<T> invokeAsync(R keyRec, InvokeProcessor<R, R, T> proc); @@ -294,14 +298,19 @@ public interface TableView<R> { * Executes an InvokeProcessor code against records with the same key columns values as the given ones has. * * @param keyRecs Records with key columns set. + * @param proc Invoke processor. + * @param <T> InvokeProcessor result type. * @return Results of the processing. */ <T extends Serializable> Map<R, T> invokeAll(Collection<R> keyRecs, InvokeProcessor<R, R, T> proc); /** - * Asynchronously executes an InvokeProcessor against records with the same key columns values as the given ones has. + * Asynchronously executes an InvokeProcessor against records with the same key columns values as the given ones + * has. * * @param keyRecs Records with key columns set. + * @param proc Invoke processor. + * @param <T> InvokeProcessor result type. * @return Results of the processing. */ @NotNull <T extends Serializable> CompletableFuture<Map<R, T>> invokeAllAsync(Collection<R> keyRecs, diff --git a/modules/core/pom.xml b/modules/core/pom.xml index 911bd7e..9959bc6 100644 --- a/modules/core/pom.xml +++ b/modules/core/pom.xml @@ -17,9 +17,6 @@ limitations under the License. --> -<!-- - POM file. ---> <project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> <modelVersion>4.0.0</modelVersion> diff --git a/modules/core/src/main/java/org/apache/ignite/internal/tostring/FieldDescriptor.java b/modules/core/src/main/java/org/apache/ignite/internal/tostring/FieldDescriptor.java index 683fae5..89c656a 100644 --- a/modules/core/src/main/java/org/apache/ignite/internal/tostring/FieldDescriptor.java +++ b/modules/core/src/main/java/org/apache/ignite/internal/tostring/FieldDescriptor.java @@ -130,7 +130,9 @@ class FieldDescriptor { return type; } - /** */ + /** + * @return Field class. + */ public Class<?> fieldClass() { return cls; } diff --git a/modules/core/src/main/java/org/apache/ignite/internal/tostring/IgniteToStringBuilder.java b/modules/core/src/main/java/org/apache/ignite/internal/tostring/IgniteToStringBuilder.java index a990d2e..a97d78b 100644 --- a/modules/core/src/main/java/org/apache/ignite/internal/tostring/IgniteToStringBuilder.java +++ b/modules/core/src/main/java/org/apache/ignite/internal/tostring/IgniteToStringBuilder.java @@ -1970,6 +1970,7 @@ public class IgniteToStringBuilder { * * @param col Collection of numbers. * @param nextValFun Function to get nearby number. + * @param <T> Comparable number type. * @return Compacted string representation of given collections. */ public static <T extends Number & Comparable<? super T>> String compact( diff --git a/modules/core/src/main/java/org/apache/ignite/internal/tostring/IgniteToStringOrder.java b/modules/core/src/main/java/org/apache/ignite/internal/tostring/IgniteToStringOrder.java index db91ad1..651b4dc 100644 --- a/modules/core/src/main/java/org/apache/ignite/internal/tostring/IgniteToStringOrder.java +++ b/modules/core/src/main/java/org/apache/ignite/internal/tostring/IgniteToStringOrder.java @@ -35,6 +35,8 @@ import java.lang.annotation.Target; public @interface IgniteToStringOrder { /** * Numeric order value. + * + * @return Field order. */ int value(); } diff --git a/modules/core/src/main/java/org/apache/ignite/internal/util/GridUnsafe.java b/modules/core/src/main/java/org/apache/ignite/internal/util/GridUnsafe.java index 1cb4f1f..3e89841 100644 --- a/modules/core/src/main/java/org/apache/ignite/internal/util/GridUnsafe.java +++ b/modules/core/src/main/java/org/apache/ignite/internal/util/GridUnsafe.java @@ -1321,6 +1321,7 @@ public abstract class GridUnsafe { * * @param cls Class. * @return Allocated instance. + * @throws InstantiationException If failed to instantiate class. */ public static Object allocateInstance(Class cls) throws InstantiationException { return UNSAFE.allocateInstance(cls); @@ -1474,6 +1475,7 @@ public abstract class GridUnsafe { * * @param mtd Method. * @param args Arguments. + * @return Method invocation result. */ public static Object invoke(Method mtd, Object... args) { try { diff --git a/modules/core/src/main/java/org/apache/ignite/lang/IgniteSystemProperties.java b/modules/core/src/main/java/org/apache/ignite/lang/IgniteSystemProperties.java index 6fae6b3..0e05e9e 100644 --- a/modules/core/src/main/java/org/apache/ignite/lang/IgniteSystemProperties.java +++ b/modules/core/src/main/java/org/apache/ignite/lang/IgniteSystemProperties.java @@ -72,8 +72,9 @@ public final class IgniteSystemProperties { } /** - * @param enumCls Enum type. + * @param enumCls Enum class. * @param name Name of the system property or environment variable. + * @param <E> Enum type. * @return Enum value or {@code null} if the property is not set. */ public static <E extends Enum<E>> E getEnum(Class<E> enumCls, String name) { @@ -82,6 +83,8 @@ public final class IgniteSystemProperties { /** * @param name Name of the system property or environment variable. + * @param dflt Default value. + * @param <E> Enum type. * @return Enum value or the given default. */ public static <E extends Enum<E>> E getEnum(String name, E dflt) { @@ -92,6 +95,7 @@ public final class IgniteSystemProperties { * @param enumCls Enum type. * @param name Name of the system property or environment variable. * @param dflt Default value. + * @param <E> Enum type. * @return Enum value or the given default. */ private static <E extends Enum<E>> E getEnum(Class<E> enumCls, String name, E dflt) { diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/BinaryRow.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/BinaryRow.java index 0bf67b4..a1ef776 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/BinaryRow.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/BinaryRow.java @@ -74,6 +74,7 @@ public interface BinaryRow { /** * Writes binary row to given stream. * + * @param stream Stream to write to. * @throws IOException If write operation fails. */ void writeTo(OutputStream stream) throws IOException; @@ -116,18 +117,20 @@ public interface BinaryRow { /** * @param off Offset. + * @param len Length. * @return String value. */ String readString(int off, int len); /** * @param off Offset. + * @param len Length. * @return Byte array. */ byte[] readBytes(int off, int len); /** - * + * Row flags. */ final class RowFlags { /** Tombstone flag. */ @@ -138,6 +141,7 @@ public interface BinaryRow { /** Stub. */ private RowFlags() { + // No-op. } } } diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/Columns.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/Columns.java index 9f7190a..84c12d7 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/Columns.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/Columns.java @@ -91,6 +91,7 @@ public class Columns { * Constructs the columns chunk. The columns will be internally sorted in write-efficient order based on * {@link Column} comparison. * + * @param baseSchemaIdx First column absolute index in schema. * @param cols Array of columns. */ Columns(int baseSchemaIdx, Column... cols) { @@ -275,14 +276,18 @@ public class Columns { } /** + * Returns columns index for given column name, + * + * @param colName Column name. + * @return Column index. */ - public int columnIndex(String fieldName) { + public int columnIndex(String colName) { for (int i = 0; i < cols.length; i++) { - if (cols[i].name().equalsIgnoreCase(fieldName)) + if (cols[i].name().equalsIgnoreCase(colName)) return i; } - throw new NoSuchElementException("No field '" + fieldName + "' defined"); + throw new NoSuchElementException("No field '" + colName + "' defined"); } /** {@inheritDoc} */ diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/ExpandableByteBuf.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/ExpandableByteBuf.java index b60655c..83fbdfd 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/ExpandableByteBuf.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/ExpandableByteBuf.java @@ -71,7 +71,10 @@ public class ExpandableByteBuf { } /** + * Writes {@code byte} value to the buffer, * + * @param off Buffer offset. + * @param val Value. */ public void put(int off, byte val) { ensureCapacity(off + 1); @@ -80,7 +83,10 @@ public class ExpandableByteBuf { } /** + * Writes {@code short} value to the buffer, * + * @param off Buffer offset. + * @param val Value. */ public void putShort(int off, short val) { ensureCapacity(off + 2); @@ -89,7 +95,10 @@ public class ExpandableByteBuf { } /** + * Writes {@code int} value to the buffer, * + * @param off Buffer offset. + * @param val Value. */ public void putInt(int off, int val) { ensureCapacity(off + 4); @@ -98,7 +107,10 @@ public class ExpandableByteBuf { } /** + * Writes {@code float} value to the buffer, * + * @param off Buffer offset. + * @param val Value. */ public void putFloat(int off, float val) { ensureCapacity(off + 4); @@ -107,7 +119,10 @@ public class ExpandableByteBuf { } /** + * Writes {@code long} value to the buffer, * + * @param off Buffer offset. + * @param val Value. */ public void putLong(int off, long val) { ensureCapacity(off + 8); @@ -116,7 +131,10 @@ public class ExpandableByteBuf { } /** + * Writes {@code double} value to the buffer, * + * @param off Buffer offset. + * @param val Value. */ public void putDouble(int off, double val) { ensureCapacity(off + 8); @@ -125,12 +143,15 @@ public class ExpandableByteBuf { } /** + * Writes {@code byte[]} value to the buffer, * + * @param off Buffer offset. + * @param val Value. */ - public void putBytes(int curOff, byte[] val) { - ensureCapacity(curOff + val.length); + public void putBytes(int off, byte[] val) { + ensureCapacity(off + val.length); - buf.position(curOff); + buf.position(off); try { buf.put(val); @@ -141,7 +162,13 @@ public class ExpandableByteBuf { } /** + * Writes {@code String} value to the buffer, * + * @param off Buffer offset. + * @param val Value. + * @param encoder Charset encoder. + * @return Bytes written. + * @throws CharacterCodingException If encoding failed. */ public int putString(int off, String val, CharsetEncoder encoder) throws CharacterCodingException { ensureCapacity(off); @@ -198,7 +225,10 @@ public class ExpandableByteBuf { } /** + * Reads {@code byte} value from buffer. * + * @param off Buffer offset. + * @return Value. */ public byte get(int off) { return buf.get(off); diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/NativeType.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/NativeType.java index d580137..d8d956a 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/NativeType.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/NativeType.java @@ -57,7 +57,10 @@ public class NativeType implements Comparable<NativeType> { private final int len; /** + * Constructor for fixed-length types. * + * @param typeSpec Type spec. + * @param len Type length. */ protected NativeType(NativeTypeSpec typeSpec, int len) { if (!typeSpec.fixedLength()) @@ -71,7 +74,9 @@ public class NativeType implements Comparable<NativeType> { } /** + * Constructor for variable-length types. * + * @param typeSpec Type spec. */ protected NativeType(NativeTypeSpec typeSpec) { if (typeSpec.fixedLength()) diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/RowAssembler.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/RowAssembler.java index 65f58ee..a42fe90 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/RowAssembler.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/RowAssembler.java @@ -80,7 +80,11 @@ public class RowAssembler { } /** - * This implementation is not tolerant to malformed char sequences. + * Calculates encoded string length. + * + * @param seq Char sequence. + * @return Encoded string length. + * @implNote This implementation is not tolerant to malformed char sequences. */ public static int utf8EncodedLength(CharSequence seq) { int cnt = 0; diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/AbstractSerializer.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/AbstractSerializer.java index 5b7e420..0cd67ad 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/AbstractSerializer.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/AbstractSerializer.java @@ -74,6 +74,7 @@ public abstract class AbstractSerializer implements Serializer { * * @param key Key object. * @param val Value object. + * @return Row assembler. */ protected abstract RowAssembler createAssembler(Object key, @Nullable Object val); diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/MarshallerUtil.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/MarshallerUtil.java index b149c00..6884d8f 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/MarshallerUtil.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/MarshallerUtil.java @@ -100,12 +100,14 @@ public final class MarshallerUtil { /** * Creates object factory for class. - * @param tClass Target type. + * + * @param tCls Target class. + * @param <T> Target type. * @return Object factory. */ - public static <T> ObjectFactory<T> factoryForClass(Class<T> tClass) { - if (mode(tClass) == null) - return new ObjectFactory<>(tClass); + public static <T> ObjectFactory<T> factoryForClass(Class<T> tCls) { + if (mode(tCls) == null) + return new ObjectFactory<>(tCls); else return null; } diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/Serializer.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/Serializer.java index c4ffcb2..d9ad99d 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/Serializer.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/Serializer.java @@ -29,21 +29,32 @@ public interface Serializer { * @param key Key object. * @param val Value object. * @return Serialized key-value pair. + * @throws SerializationException If serialization failed. */ byte[] serialize(Object key, Object val) throws SerializationException; /** + * @param data Key bytes. + * @param <K> Key object type. * @return Key object. + * @throws SerializationException If deserialization failed. */ <K> K deserializeKey(byte[] data) throws SerializationException; /** + * @param data Value bytes. + * @param <V> Value object type. * @return Value object. + * @throws SerializationException If deserialization failed. */ <V> V deserializeValue(byte[] data) throws SerializationException; /** + * @param data Row bytes. + * @param <K> Key object type. + * @param <V> Value object type. * @return Key-value pair. + * @throws SerializationException If deserialization failed. */ <K, V> Pair<K,V> deserialize(byte[] data) throws SerializationException; } diff --git a/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/reflection/FieldAccessor.java b/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/reflection/FieldAccessor.java index 703c62c..017b7be 100644 --- a/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/reflection/FieldAccessor.java +++ b/modules/schema/src/main/java/org/apache/ignite/internal/schema/marshaller/reflection/FieldAccessor.java @@ -345,6 +345,7 @@ abstract class FieldAccessor { * * @param writer Row writer. * @param obj Source object. + * @throws Exception If write failed. */ protected abstract void write0(RowAssembler writer, Object obj) throws Exception; diff --git a/modules/table/src/main/java/org/apache/ignite/binary/BinaryObjects.java b/modules/table/src/main/java/org/apache/ignite/binary/BinaryObjects.java index 2004139..459068b 100644 --- a/modules/table/src/main/java/org/apache/ignite/binary/BinaryObjects.java +++ b/modules/table/src/main/java/org/apache/ignite/binary/BinaryObjects.java @@ -23,6 +23,7 @@ package org.apache.ignite.binary; public final class BinaryObjects { /** * Wraps byte array to BinaryObject. + * * @param data Object data. * @return Binary object. */ @@ -35,6 +36,7 @@ public final class BinaryObjects { * * @param obj Object to deserialize. * @param targetCls Target class. + * @param <T> Target type. * @return Deserialized object. */ public static <T> T deserialize(BinaryObject obj, Class<T> targetCls) { diff --git a/modules/table/src/main/java/org/apache/ignite/internal/schema/marshaller/KVSerializer.java b/modules/table/src/main/java/org/apache/ignite/internal/schema/marshaller/KVSerializer.java index 7668499..5c4f32d 100644 --- a/modules/table/src/main/java/org/apache/ignite/internal/schema/marshaller/KVSerializer.java +++ b/modules/table/src/main/java/org/apache/ignite/internal/schema/marshaller/KVSerializer.java @@ -22,14 +22,15 @@ import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; /** - * Key-value marshaller interface. + * Key-value serializer interface. */ public interface KVSerializer<K, V> { /** - * @param obj Object to serialize. - * @return Table row with columns set from given object. + * @param key Key object to serialize. + * @param val Value object to serialize. + * @return Table row with columns serialized from given key-value pair. */ - Row serialize(@NotNull K obj, V val); + Row serialize(@NotNull K key, V val); /** * @param row Table row. diff --git a/modules/table/src/main/java/org/apache/ignite/internal/table/AbstractTableView.java b/modules/table/src/main/java/org/apache/ignite/internal/table/AbstractTableView.java index d5f143e..1242f6e 100644 --- a/modules/table/src/main/java/org/apache/ignite/internal/table/AbstractTableView.java +++ b/modules/table/src/main/java/org/apache/ignite/internal/table/AbstractTableView.java @@ -45,6 +45,7 @@ abstract class AbstractTableView { * Waits for operation completion. * * @param fut Future to wait to. + * @param <T> Future result type. * @return Future result. */ protected <T> T sync(CompletableFuture<T> fut) { diff --git a/modules/table/src/main/java/org/apache/ignite/internal/table/TableImpl.java b/modules/table/src/main/java/org/apache/ignite/internal/table/TableImpl.java index 44b4743..445859a 100644 --- a/modules/table/src/main/java/org/apache/ignite/internal/table/TableImpl.java +++ b/modules/table/src/main/java/org/apache/ignite/internal/table/TableImpl.java @@ -49,6 +49,7 @@ public class TableImpl extends AbstractTableView implements Table { * Constructor. * * @param tbl Table. + * @param schemaMgr Table schema manager. */ public TableImpl(InternalTable tbl, TableSchemaManager schemaMgr) { super(tbl, schemaMgr);
