Merge pull request #1651 from ClickHouse/fix_javadoc

Fixed javadocs
ClickHouse · May 26, 2024 · 067ae0b · 067ae0b
2 parents 1d2961c + 5c7d0f2
commit 067ae0b
Showing 1 changed file with 33 additions and 37 deletions.
diff --git a/...v2/src/main/java/com/clickhouse/client/api/data_formats/ClickHouseBinaryFormatReader.java b/...v2/src/main/java/com/clickhouse/client/api/data_formats/ClickHouseBinaryFormatReader.java
@@ -26,7 +26,6 @@ public interface ClickHouseBinaryFormatReader {
  *
  * @param <T>
  * @return
- * @throws IOException
  */
  <T> T readValue(int colIndex);
 
@@ -36,7 +35,6 @@ public interface ClickHouseBinaryFormatReader {
  * @param colName
  * @param <T>
  * @return
- * @throws IOException
  */
  <T> T readValue(String colName);
 
@@ -149,7 +147,7 @@ public interface ClickHouseBinaryFormatReader {
  /**
  * Returns the value of the specified column as an Instant. Timezone is derived from the column definition.
  * If no timezone is specified in the column definition then UTC will be used.
- * </br>
+ * 
  * If column value is Date or Date32 it will return an Instant with time set to 00:00:00.
  * If column value is DateTime or DateTime32 it will return an Instant with the time part.
  *
@@ -161,7 +159,7 @@ public interface ClickHouseBinaryFormatReader {
  /**
  * Returns the value of the specified column as a ZonedDateTime. Timezone is derived from the column definition.
  * If no timezone is specified in the column definition then UTC will be used.
- * </br>
+ * 
  * If column value is Date or Date32 it will return a ZonedDateTime with time set to 00:00:00.
  * If column value is DateTime or DateTime32 it will return a ZonedDateTime with the time part.
  *
@@ -172,10 +170,10 @@ public interface ClickHouseBinaryFormatReader {
 
  /**
  * Returns the value of the specified column as a Duration.
- * </br>
+ * 
  * If a stored value is bigger than Long.MAX_VALUE then exception will be thrown. In such case
  * use asBigInteger() method.
- * </br>
+ * 
  * If value of IntervalQuarter then Duration will be in the unit of Months.
  *
  * @param colName
@@ -307,87 +305,87 @@ public interface ClickHouseBinaryFormatReader {
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index
  * @return
  */
  String getString(int index);
 
  /**
  * Reads column with name `colName` as a byte.
  *
- * @param colName - column name
+ * @param index
  * @return
  */
  byte getByte(int index);
 
  /**
  * Reads column with name `colName` as a short.
  *
- * @param colName - column name
+ * @param index
  * @return
  */
  short getShort(int index);
 
  /**
  * Reads column with name `colName` as an integer.
  *
- * @param colName - column name
+ * @param index
  * @return
  */
  int getInteger(int index);
 
  /**
  * Reads column with name `colName` as a long.
  *
- * @param colName - column name
+ * @param index
  * @return
  */
  long getLong(int index);
 
  /**
  * Reads column with name `colName` as a float.
  *
- * @param colName
+ * @param index
  * @return
  */
  float getFloat(int index);
 
  /**
  * Reads column with name `colName` as a double.
  *
- * @param colName
+ * @param index
  * @return
  */
  double getDouble(int index);
 
  /**
  * Reads column with name `colName` as a boolean.
  *
- * @param colName
+ * @param index
  * @return
  */
  boolean getBoolean(int index);
 
  /**
  * Reads column with name `colName` as a BigInteger.
  *
- * @param colName
+ * @param index
  * @return
  */
  BigInteger getBigInteger(int index);
 
  /**
  * Reads column with name `colName` as a BigDecimal.
  *
- * @param colName
+ * @param index
  * @return
  */
  BigDecimal getBigDecimal(int index);
 
  /**
  * Returns the value of the specified column as an Instant. Timezone is derived from the column definition.
  * If no timezone is specified in the column definition then UTC will be used.
- * </br>
+ * 
  * If column value is Date or Date32 it will return an Instant with time set to 00:00:00.
  * If column value is DateTime or DateTime32 it will return an Instant with the time part.
  *
@@ -399,24 +397,22 @@ public interface ClickHouseBinaryFormatReader {
  /**
  * Returns the value of the specified column as a ZonedDateTime. Timezone is derived from the column definition.
  * If no timezone is specified in the column definition then UTC will be used.
- * </br>
+ * 
  * If column value is Date or Date32 it will return a ZonedDateTime with time set to 00:00:00.
  * If column value is DateTime or DateTime32 it will return a ZonedDateTime with the time part.
  *
- * @param colName
+ * @param index
  * @return
  */
  ZonedDateTime getZonedDateTime(int index);
 
  /**
  * Returns the value of the specified column as a Duration.
- * </br>
  * If a stored value is bigger than Long.MAX_VALUE then exception will be thrown. In such case
  * use asBigInteger() method.
- * </br>
  * If value of IntervalQuarter then Duration will be in the unit of Months.
  *
- * @param colName
+ * @param index
  * @return Duration in the unit of column type.
  */
  Duration getDuration(int index);
@@ -425,119 +421,119 @@ public interface ClickHouseBinaryFormatReader {
  /**
  * Returns the value of the specified column as an Inet4Address.
  *
- * @param colName
+ * @param index
  * @return
  */
  Inet4Address getInet4Address(int index);
 
  /**
  * Returns the value of the specified column as an Inet6Address.
  *
- * @param colName
+ * @param index
  * @return
  */
  Inet6Address getInet6Address(int index);
 
  /**
  * Returns the value of the specified column as a UUID.
  *
- * @param colName
+ * @param index
  * @return
  */
  UUID getUUID(int index);
 
  /**
  * Returns the value of the specified column as a ClickHouseGeoPointValue.
  *
- * @param colName
+ * @param index
  * @return
  */
  ClickHouseGeoPointValue getGeoPoint(int index);
 
  /**
  * Returns the value of the specified column as a ClickHouseGeoRingValue.
  *
- * @param colName
+ * @param index
  * @return
  */
  ClickHouseGeoRingValue getGeoRing(int index);
 
  /**
  * Returns the value of the specified column as a ClickHouseGeoPolygonValue.
  *
- * @param colName
+ * @param index
  * @return
  */
  ClickHouseGeoPolygonValue asGeoPolygon(int index);
 
  /**
  * Returns the value of the specified column as a ClickHouseGeoMultiPolygonValue.
  *
- * @param colName
+ * @param index
  * @return
  */
  ClickHouseGeoMultiPolygonValue asGeoMultiPolygon(int index);
 
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index - column name
  * @return
  */
  <T> List<T> getList(int index);
 
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index - column name
  * @return
  */
  <T> List<List<T>> getTwoDimensionalList(int index);
 
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index - column name
  * @return
  */
  <T> List<List<List<T>>> getThreeDimensionalList(int index);
 
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index - column name
  * @return
  */
  byte[] getByteArray(int index);
 
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index - column name
  * @return
  */
  int[] getIntArray(int index);
 
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index - column name
  * @return
  */
  long[] getLongArray(int index);
 
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index - column name
  * @return
  */
  float[] getFloatArray(int index);
 
  /**
  * Reads column with name `colName` as a string.
  *
- * @param colName - column name
+ * @param index - column name
  * @return
  */
  double[] getDoubleArray(int index);