/src/java/org/apache/cassandra/cql3/functions/types/GettableByIndexData.java

https://github.com/apache/cassandra · Java · 592 lines · 42 code · 34 blank · 516 comment · 0 complexity · 99d32985475989e26e47032abc4e1cb3 MD5 · raw file 

    

  1. /*
    2. 

  2.  * Licensed to the Apache Software Foundation (ASF) under one
    3. 

  3.  * or more contributor license agreements.  See the NOTICE file
    4. 

  4.  * distributed with this work for additional information
    5. 

  5.  * regarding copyright ownership.  The ASF licenses this file
    6. 

  6.  * to you under the Apache License, Version 2.0 (the
    7. 

  7.  * "License"); you may not use this file except in compliance
    8. 

  8.  * with the License.  You may obtain a copy of the License at
    9. 

  9.  *
    10. 

  10.  *     http://www.apache.org/licenses/LICENSE-2.0
    11. 

  11.  *
    12. 

  12.  * Unless required by applicable law or agreed to in writing, software
    13. 

  13.  * distributed under the License is distributed on an "AS IS" BASIS,
    14. 

  14.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    15. 

  15.  * See the License for the specific language governing permissions and
    16. 

  16.  * limitations under the License.
    17. 

  17.  */
    18. 

  18. package org.apache.cassandra.cql3.functions.types;
    19. 

  19. 

  20. import java.math.BigDecimal;
    21. 

  21. import java.math.BigInteger;
    22. 

  22. import java.net.InetAddress;
    23. 

  23. import java.nio.ByteBuffer;
    24. 

  24. import java.util.*;
    25. 

  25. 

  26. import com.google.common.reflect.TypeToken;
    27. 

  27. 

  28. import org.apache.cassandra.cql3.functions.types.exceptions.CodecNotFoundException;
    29. 

  29. import org.apache.cassandra.cql3.functions.types.exceptions.InvalidTypeException;
    30. 

  30. 

  31. /**
    32. 

  32.  * Collection of (typed) CQL values that can be retrieved by index (starting at zero).
    33. 

  33.  */
    34. 

  34. public interface GettableByIndexData
    35. 

  35. {
    36. 

  36. 

  37.     /**
    38. 

  38.      * Returns whether the {@code i}th value is NULL.
    39. 

  39.      *
    40. 

  40.      * @param i the index ({@code 0 <= i < size()}) of the value to check.
    41. 

  41.      * @return whether the {@code i}th value is NULL.
    42. 

  42.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    43. 

  43.      */
    44. 

  44.     public boolean isNull(int i);
    45. 

  45. 

  46.     /**
    47. 

  47.      * Returns the {@code i}th value as a boolean.
    48. 

  48.      *
    49. 

  49.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    50. 

  50.      * type to a Java {@code boolean} (for CQL type {@code boolean}, this will be the built-in codec).
    51. 

  51.      *
    52. 

  52.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    53. 

  53.      * @return the boolean value of the {@code i}th element. If the value is NULL, {@code false} is
    54. 

  54.      * returned. If you need to distinguish NULL and false values, check first with {@link
    55. 

  55.      * #isNull(int)} or use {@code get(i, Boolean.class)}.
    56. 

  56.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    57. 

  57.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    58. 

  58.      *                                   type to a boolean.
    59. 

  59.      */
    60. 

  60.     public boolean getBool(int i);
    61. 

  61. 

  62.     /**
    63. 

  63.      * Returns the {@code i}th value as a byte.
    64. 

  64.      *
    65. 

  65.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    66. 

  66.      * type to a Java {@code byte} (for CQL type {@code tinyint}, this will be the built-in codec).
    67. 

  67.      *
    68. 

  68.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    69. 

  69.      * @return the value of the {@code i}th element as a byte. If the value is NULL, {@code 0} is
    70. 

  70.      * returned. If you need to distinguish NULL and 0, check first with {@link #isNull(int)} or
    71. 

  71.      * use {@code get(i, Byte.class)}.
    72. 

  72.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    73. 

  73.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    74. 

  74.      *                                   type to a byte.
    75. 

  75.      */
    76. 

  76.     public byte getByte(int i);
    77. 

  77. 

  78.     /**
    79. 

  79.      * Returns the {@code i}th value as a short.
    80. 

  80.      *
    81. 

  81.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    82. 

  82.      * type to a Java {@code short} (for CQL type {@code smallint}, this will be the built-in codec).
    83. 

  83.      *
    84. 

  84.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    85. 

  85.      * @return the value of the {@code i}th element as a short. If the value is NULL, {@code 0} is
    86. 

  86.      * returned. If you need to distinguish NULL and 0, check first with {@link #isNull(int)} or
    87. 

  87.      * use {@code get(i, Short.class)}.
    88. 

  88.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    89. 

  89.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    90. 

  90.      *                                   type to a short.
    91. 

  91.      */
    92. 

  92.     public short getShort(int i);
    93. 

  93. 

  94.     /**
    95. 

  95.      * Returns the {@code i}th value as an integer.
    96. 

  96.      *
    97. 

  97.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    98. 

  98.      * type to a Java {@code int} (for CQL type {@code int}, this will be the built-in codec).
    99. 

  99.      *
    100. 

  100.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    101. 

  101.      * @return the value of the {@code i}th element as an integer. If the value is NULL, {@code 0} is
    102. 

  102.      * returned. If you need to distinguish NULL and 0, check first with {@link #isNull(int)} or
    103. 

  103.      * use {@code get(i, Integer.class)}.
    104. 

  104.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    105. 

  105.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    106. 

  106.      *                                   type to an int.
    107. 

  107.      */
    108. 

  108.     public int getInt(int i);
    109. 

  109. 

  110.     /**
    111. 

  111.      * Returns the {@code i}th value as a long.
    112. 

  112.      *
    113. 

  113.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    114. 

  114.      * type to a Java {@code byte} (for CQL types {@code bigint} and {@code counter}, this will be the
    115. 

  115.      * built-in codec).
    116. 

  116.      *
    117. 

  117.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    118. 

  118.      * @return the value of the {@code i}th element as a long. If the value is NULL, {@code 0L} is
    119. 

  119.      * returned. If you need to distinguish NULL and 0L, check first with {@link #isNull(int)} or
    120. 

  120.      * use {@code get(i, Long.class)}.
    121. 

  121.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    122. 

  122.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    123. 

  123.      *                                   type to a long.
    124. 

  124.      */
    125. 

  125.     public long getLong(int i);
    126. 

  126. 

  127.     /**
    128. 

  128.      * Returns the {@code i}th value as a date.
    129. 

  129.      *
    130. 

  130.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    131. 

  131.      * type to a {@code Date} (for CQL type {@code timestamp}, this will be the built-in codec).
    132. 

  132.      *
    133. 

  133.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    134. 

  134.      * @return the value of the {@code i}th element as a data. If the value is NULL, {@code null} is
    135. 

  135.      * returned.
    136. 

  136.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    137. 

  137.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    138. 

  138.      *                                   type to a {@code Date}.
    139. 

  139.      */
    140. 

  140.     public Date getTimestamp(int i);
    141. 

  141. 

  142.     /**
    143. 

  143.      * Returns the {@code i}th value as a date (without time).
    144. 

  144.      *
    145. 

  145.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    146. 

  146.      * type to a {@link LocalDate} (for CQL type {@code date}, this will be the built-in codec).
    147. 

  147.      *
    148. 

  148.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    149. 

  149.      * @return the value of the {@code i}th element as an date. If the value is NULL, {@code null} is
    150. 

  150.      * returned.
    151. 

  151.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    152. 

  152.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    153. 

  153.      *                                   type to a {@code LocalDate}.
    154. 

  154.      */
    155. 

  155.     public LocalDate getDate(int i);
    156. 

  156. 

  157.     /**
    158. 

  158.      * Returns the {@code i}th value as a long in nanoseconds since midnight.
    159. 

  159.      *
    160. 

  160.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    161. 

  161.      * type to a Java {@code long} (for CQL type {@code time}, this will be the built-in codec).
    162. 

  162.      *
    163. 

  163.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    164. 

  164.      * @return the value of the {@code i}th element as a long. If the value is NULL, {@code 0L} is
    165. 

  165.      * returned.
    166. 

  166.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    167. 

  167.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    168. 

  168.      *                                   type to a long.
    169. 

  169.      */
    170. 

  170.     public long getTime(int i);
    171. 

  171. 

  172.     /**
    173. 

  173.      * Returns the {@code i}th value as a float.
    174. 

  174.      *
    175. 

  175.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    176. 

  176.      * type to a Java {@code float} (for CQL type {@code float}, this will be the built-in codec).
    177. 

  177.      *
    178. 

  178.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    179. 

  179.      * @return the value of the {@code i}th element as a float. If the value is NULL, {@code 0.0f} is
    180. 

  180.      * returned. If you need to distinguish NULL and 0.0f, check first with {@link #isNull(int)}
    181. 

  181.      * or use {@code get(i, Float.class)}.
    182. 

  182.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    183. 

  183.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    184. 

  184.      *                                   type to a float.
    185. 

  185.      */
    186. 

  186.     public float getFloat(int i);
    187. 

  187. 

  188.     /**
    189. 

  189.      * Returns the {@code i}th value as a double.
    190. 

  190.      *
    191. 

  191.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    192. 

  192.      * type to a Java {@code double} (for CQL type {@code double}, this will be the built-in codec).
    193. 

  193.      *
    194. 

  194.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    195. 

  195.      * @return the value of the {@code i}th element as a double. If the value is NULL, {@code 0.0} is
    196. 

  196.      * returned. If you need to distinguish NULL and 0.0, check first with {@link #isNull(int)} or
    197. 

  197.      * use {@code get(i, Double.class)}.
    198. 

  198.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    199. 

  199.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    200. 

  200.      *                                   type to a double.
    201. 

  201.      */
    202. 

  202.     public double getDouble(int i);
    203. 

  203. 

  204.     /**
    205. 

  205.      * Returns the {@code i}th value as a {@code ByteBuffer}.
    206. 

  206.      *
    207. 

  207.      * <p>This method does not use any codec; it returns a copy of the binary representation of the
    208. 

  208.      * value. It is up to the caller to convert the returned value appropriately.
    209. 

  209.      *
    210. 

  210.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    211. 

  211.      * @return the value of the {@code i}th element as a ByteBuffer. If the value is NULL, {@code
    212. 

  212.      * null} is returned.
    213. 

  213.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    214. 

  214.      */
    215. 

  215.     public ByteBuffer getBytesUnsafe(int i);
    216. 

  216. 

  217.     /**
    218. 

  218.      * Returns the {@code i}th value as a byte array.
    219. 

  219.      *
    220. 

  220.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    221. 

  221.      * type to a Java {@code ByteBuffer} (for CQL type {@code blob}, this will be the built-in codec).
    222. 

  222.      *
    223. 

  223.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    224. 

  224.      * @return the value of the {@code i}th element as a byte array. If the value is NULL, {@code
    225. 

  225.      * null} is returned.
    226. 

  226.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    227. 

  227.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    228. 

  228.      *                                   type to a {@code ByteBuffer}.
    229. 

  229.      */
    230. 

  230.     public ByteBuffer getBytes(int i);
    231. 

  231. 

  232.     /**
    233. 

  233.      * Returns the {@code i}th value as a string.
    234. 

  234.      *
    235. 

  235.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    236. 

  236.      * type to a Java string (for CQL types {@code text}, {@code varchar} and {@code ascii}, this will
    237. 

  237.      * be the built-in codec).
    238. 

  238.      *
    239. 

  239.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    240. 

  240.      * @return the value of the {@code i}th element as a string. If the value is NULL, {@code null} is
    241. 

  241.      * returned.
    242. 

  242.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    243. 

  243.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    244. 

  244.      *                                   type to a string.
    245. 

  245.      */
    246. 

  246.     public String getString(int i);
    247. 

  247. 

  248.     /**
    249. 

  249.      * Returns the {@code i}th value as a variable length integer.
    250. 

  250.      *
    251. 

  251.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    252. 

  252.      * type to a {@code BigInteger} (for CQL type {@code varint}, this will be the built-in codec).
    253. 

  253.      *
    254. 

  254.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    255. 

  255.      * @return the value of the {@code i}th element as a variable length integer. If the value is
    256. 

  256.      * NULL, {@code null} is returned.
    257. 

  257.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    258. 

  258.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    259. 

  259.      *                                   type to a {@code BigInteger}.
    260. 

  260.      */
    261. 

  261.     public BigInteger getVarint(int i);
    262. 

  262. 

  263.     /**
    264. 

  264.      * Returns the {@code i}th value as a variable length decimal.
    265. 

  265.      *
    266. 

  266.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    267. 

  267.      * type to a {@code BigDecimal} (for CQL type {@code decimal}, this will be the built-in codec).
    268. 

  268.      *
    269. 

  269.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    270. 

  270.      * @return the value of the {@code i}th element as a variable length decimal. If the value is
    271. 

  271.      * NULL, {@code null} is returned.
    272. 

  272.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    273. 

  273.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    274. 

  274.      *                                   type to a {@code BigDecimal}.
    275. 

  275.      */
    276. 

  276.     public BigDecimal getDecimal(int i);
    277. 

  277. 

  278.     /**
    279. 

  279.      * Returns the {@code i}th value as a UUID.
    280. 

  280.      *
    281. 

  281.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    282. 

  282.      * type to a {@code UUID} (for CQL types {@code uuid} and {@code timeuuid}, this will be the
    283. 

  283.      * built-in codec).
    284. 

  284.      *
    285. 

  285.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    286. 

  286.      * @return the value of the {@code i}th element as a UUID. If the value is NULL, {@code null} is
    287. 

  287.      * returned.
    288. 

  288.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    289. 

  289.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    290. 

  290.      *                                   type to a {@code UUID}.
    291. 

  291.      */
    292. 

  292.     public UUID getUUID(int i);
    293. 

  293. 

  294.     /**
    295. 

  295.      * Returns the {@code i}th value as an InetAddress.
    296. 

  296.      *
    297. 

  297.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    298. 

  298.      * type to an {@code InetAddress} (for CQL type {@code inet}, this will be the built-in codec).
    299. 

  299.      *
    300. 

  300.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    301. 

  301.      * @return the value of the {@code i}th element as an InetAddress. If the value is NULL, {@code
    302. 

  302.      * null} is returned.
    303. 

  303.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    304. 

  304.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    305. 

  305.      *                                   type to a {@code InetAddress}.
    306. 

  306.      */
    307. 

  307.     public InetAddress getInet(int i);
    308. 

  308. 

  309.     /**
    310. 

  310.      * Returns the {@code i}th value as a list.
    311. 

  311.      *
    312. 

  312.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    313. 

  313.      * type to a list of the specified type.
    314. 

  314.      *
    315. 

  315.      * <p>If the type of the elements is generic, use {@link #getList(int, TypeToken)}.
    316. 

  316.      *
    317. 

  317.      * <p>Implementation note: the actual {@link List} implementation will depend on the {@link
    318. 

  318.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    319. 

  319.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    320. 

  320.      * {@code NULL} values is also codec-dependent. By default, the driver will return mutable
    321. 

  321.      * instances, and a CQL {@code NULL} will be mapped to an empty collection (note that Cassandra
    322. 

  322.      * makes no distinction between {@code NULL} and an empty collection).
    323. 

  323.      *
    324. 

  324.      * @param i             the index ({@code 0 <= i < size()}) to retrieve.
    325. 

  325.      * @param elementsClass the class for the elements of the list to retrieve.
    326. 

  326.      * @return the value of the {@code i}th element as a list of {@code T} objects.
    327. 

  327.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    328. 

  328.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    329. 

  329.      *                                   type to a list.
    330. 

  330.      */
    331. 

  331.     public <T> List<T> getList(int i, Class<T> elementsClass);
    332. 

  332. 

  333.     /**
    334. 

  334.      * Returns the {@code i}th value as a list.
    335. 

  335.      *
    336. 

  336.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    337. 

  337.      * type to a list of the specified type.
    338. 

  338.      *
    339. 

  339.      * <p>Use this variant with nested collections, which produce a generic element type:
    340. 

  340.      *
    341. 

  341.      * <pre>
    342. 

  342.      * {@code List<List<String>> l = row.getList(1, new TypeToken<List<String>>() {});}
    343. 

  343.      * </pre>
    344. 

  344.      *
    345. 

  345.      * <p>Implementation note: the actual {@link List} implementation will depend on the {@link
    346. 

  346.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    347. 

  347.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    348. 

  348.      * {@code NULL} values is also codec-dependent. By default, the driver will return mutable
    349. 

  349.      * instances, and a CQL {@code NULL} will mapped to an empty collection (note that Cassandra makes
    350. 

  350.      * no distinction between {@code NULL} and an empty collection).
    351. 

  351.      *
    352. 

  352.      * @param i            the index ({@code 0 <= i < size()}) to retrieve.
    353. 

  353.      * @param elementsType the type of the elements of the list to retrieve.
    354. 

  354.      * @return the value of the {@code i}th element as a list of {@code T} objects.
    355. 

  355.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    356. 

  356.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    357. 

  357.      *                                   type to a list.
    358. 

  358.      */
    359. 

  359.     public <T> List<T> getList(int i, TypeToken<T> elementsType);
    360. 

  360. 

  361.     /**
    362. 

  362.      * Returns the {@code i}th value as a set.
    363. 

  363.      *
    364. 

  364.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    365. 

  365.      * type to a set of the specified type.
    366. 

  366.      *
    367. 

  367.      * <p>If the type of the elements is generic, use {@link #getSet(int, TypeToken)}.
    368. 

  368.      *
    369. 

  369.      * <p>Implementation note: the actual {@link Set} implementation will depend on the {@link
    370. 

  370.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    371. 

  371.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    372. 

  372.      * {@code NULL} values is also codec-dependent. By default, the driver will return mutable
    373. 

  373.      * instances, and a CQL {@code NULL} will mapped to an empty collection (note that Cassandra makes
    374. 

  374.      * no distinction between {@code NULL} and an empty collection).
    375. 

  375.      *
    376. 

  376.      * @param i             the index ({@code 0 <= i < size()}) to retrieve.
    377. 

  377.      * @param elementsClass the class for the elements of the set to retrieve.
    378. 

  378.      * @return the value of the {@code i}th element as a set of {@code T} objects.
    379. 

  379.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    380. 

  380.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    381. 

  381.      *                                   type to a set.
    382. 

  382.      */
    383. 

  383.     public <T> Set<T> getSet(int i, Class<T> elementsClass);
    384. 

  384. 

  385.     /**
    386. 

  386.      * Returns the {@code i}th value as a set.
    387. 

  387.      *
    388. 

  388.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    389. 

  389.      * type to a set of the specified type.
    390. 

  390.      *
    391. 

  391.      * <p>Use this variant with nested collections, which produce a generic element type:
    392. 

  392.      *
    393. 

  393.      * <pre>
    394. 

  394.      * {@code Set<List<String>> l = row.getSet(1, new TypeToken<List<String>>() {});}
    395. 

  395.      * </pre>
    396. 

  396.      *
    397. 

  397.      * <p>Implementation note: the actual {@link Set} implementation will depend on the {@link
    398. 

  398.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    399. 

  399.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    400. 

  400.      * {@code NULL} values is also codec-dependent. By default, the driver will return mutable
    401. 

  401.      * instances, and a CQL {@code NULL} will mapped to an empty collection (note that Cassandra makes
    402. 

  402.      * no distinction between {@code NULL} and an empty collection).
    403. 

  403.      *
    404. 

  404.      * @param i            the index ({@code 0 <= i < size()}) to retrieve.
    405. 

  405.      * @param elementsType the type for the elements of the set to retrieve.
    406. 

  406.      * @return the value of the {@code i}th element as a set of {@code T} objects.
    407. 

  407.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    408. 

  408.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    409. 

  409.      *                                   type to a set.
    410. 

  410.      */
    411. 

  411.     public <T> Set<T> getSet(int i, TypeToken<T> elementsType);
    412. 

  412. 

  413.     /**
    414. 

  414.      * Returns the {@code i}th value as a map.
    415. 

  415.      *
    416. 

  416.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    417. 

  417.      * type to a map of the specified types.
    418. 

  418.      *
    419. 

  419.      * <p>If the type of the keys and/or values is generic, use {@link #getMap(int, TypeToken,
    420. 

  420.      * TypeToken)}.
    421. 

  421.      *
    422. 

  422.      * <p>Implementation note: the actual {@link Map} implementation will depend on the {@link
    423. 

  423.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    424. 

  424.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    425. 

  425.      * {@code NULL} values is also codec-dependent. By default, the driver will return mutable
    426. 

  426.      * instances, and a CQL {@code NULL} will mapped to an empty collection (note that Cassandra makes
    427. 

  427.      * no distinction between {@code NULL} and an empty collection).
    428. 

  428.      *
    429. 

  429.      * @param i           the index ({@code 0 <= i < size()}) to retrieve.
    430. 

  430.      * @param keysClass   the class for the keys of the map to retrieve.
    431. 

  431.      * @param valuesClass the class for the values of the map to retrieve.
    432. 

  432.      * @return the value of the {@code i}th element as a map of {@code K} to {@code V} objects.
    433. 

  433.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    434. 

  434.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    435. 

  435.      *                                   type to a map.
    436. 

  436.      */
    437. 

  437.     public <K, V> Map<K, V> getMap(int i, Class<K> keysClass, Class<V> valuesClass);
    438. 

  438. 

  439.     /**
    440. 

  440.      * Returns the {@code i}th value as a map.
    441. 

  441.      *
    442. 

  442.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    443. 

  443.      * type to a map of the specified types.
    444. 

  444.      *
    445. 

  445.      * <p>Use this variant with nested collections, which produce a generic element type:
    446. 

  446.      *
    447. 

  447.      * <pre>
    448. 

  448.      * {@code Map<Int, List<String>> l = row.getMap(1, TypeToken.of(Integer.class), new TypeToken<List<String>>() {});}
    449. 

  449.      * </pre>
    450. 

  450.      *
    451. 

  451.      * <p>Implementation note: the actual {@link Map} implementation will depend on the {@link
    452. 

  452.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    453. 

  453.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    454. 

  454.      * {@code NULL} values is also codec-dependent. By default, the driver will return mutable
    455. 

  455.      * instances, and a CQL {@code NULL} will mapped to an empty collection (note that Cassandra makes
    456. 

  456.      * no distinction between {@code NULL} and an empty collection).
    457. 

  457.      *
    458. 

  458.      * @param i          the index ({@code 0 <= i < size()}) to retrieve.
    459. 

  459.      * @param keysType   the type for the keys of the map to retrieve.
    460. 

  460.      * @param valuesType the type for the values of the map to retrieve.
    461. 

  461.      * @return the value of the {@code i}th element as a map of {@code K} to {@code V} objects.
    462. 

  462.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    463. 

  463.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    464. 

  464.      *                                   type to a map.
    465. 

  465.      */
    466. 

  466.     public <K, V> Map<K, V> getMap(int i, TypeToken<K> keysType, TypeToken<V> valuesType);
    467. 

  467. 

  468.     /**
    469. 

  469.      * Return the {@code i}th value as a UDT value.
    470. 

  470.      *
    471. 

  471.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    472. 

  472.      * type to a {@code UDTValue} (if the CQL type is a UDT, the registry will generate a codec
    473. 

  473.      * automatically).
    474. 

  474.      *
    475. 

  475.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    476. 

  476.      * @return the value of the {@code i}th element as a UDT value. If the value is NULL, then {@code
    477. 

  477.      * null} will be returned.
    478. 

  478.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    479. 

  479.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    480. 

  480.      *                                   type to a {@code UDTValue}.
    481. 

  481.      */
    482. 

  482.     public UDTValue getUDTValue(int i);
    483. 

  483. 

  484.     /**
    485. 

  485.      * Return the {@code i}th value as a tuple value.
    486. 

  486.      *
    487. 

  487.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    488. 

  488.      * type to a {@code TupleValue} (if the CQL type is a tuple, the registry will generate a codec
    489. 

  489.      * automatically).
    490. 

  490.      *
    491. 

  491.      * @param i the index ({@code 0 <= i < size()}) to retrieve.
    492. 

  492.      * @return the value of the {@code i}th element as a tuple value. If the value is NULL, then
    493. 

  493.      * {@code null} will be returned.
    494. 

  494.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    495. 

  495.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    496. 

  496.      *                                   type to a {@code TupleValue}.
    497. 

  497.      */
    498. 

  498.     public TupleValue getTupleValue(int i);
    499. 

  499. 

  500.     /**
    501. 

  501.      * Returns the {@code i}th value as the Java type matching its CQL type.
    502. 

  502.      *
    503. 

  503.      * <p>This method uses the {@link CodecRegistry} to find the first codec that handles the
    504. 

  504.      * underlying CQL type. The Java type of the returned object will be determined by the codec that
    505. 

  505.      * was selected.
    506. 

  506.      *
    507. 

  507.      * <p>Use this method to dynamically inspect elements when types aren't known in advance, for
    508. 

  508.      * instance if you're writing a generic row logger. If you know the target Java type, it is
    509. 

  509.      * generally preferable to use typed getters, such as the ones for built-in types ({@link
    510. 

  510.      * #getBool(int)}, {@link #getInt(int)}, etc.), or {@link #get(int, Class)} and {@link #get(int,
    511. 

  511.      * TypeToken)} for custom types.
    512. 

  512.      *
    513. 

  513.      * @param i the index to retrieve.
    514. 

  514.      * @return the value of the {@code i}th value as the Java type matching its CQL type.
    515. 

  515.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    516. 

  516.      * @see CodecRegistry#codecFor(DataType)
    517. 

  517.      */
    518. 

  518.     public Object getObject(int i);
    519. 

  519. 

  520.     /**
    521. 

  521.      * Returns the {@code i}th value converted to the given Java type.
    522. 

  522.      *
    523. 

  523.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    524. 

  524.      * type to the given Java type.
    525. 

  525.      *
    526. 

  526.      * <p>If the target type is generic, use {@link #get(int, TypeToken)}.
    527. 

  527.      *
    528. 

  528.      * <p>Implementation note: the actual object returned by this method will depend on the {@link
    529. 

  529.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    530. 

  530.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    531. 

  531.      * {@code NULL} values is also codec-dependent; by default, a CQL {@code NULL} value translates to
    532. 

  532.      * {@code null} for simple CQL types, UDTs and tuples, and to empty collections for all CQL
    533. 

  533.      * collection types.
    534. 

  534.      *
    535. 

  535.      * @param i           the index to retrieve.
    536. 

  536.      * @param targetClass The Java type the value should be converted to.
    537. 

  537.      * @return the value of the {@code i}th value converted to the given Java type.
    538. 

  538.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    539. 

  539.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    540. 

  540.      *                                   type to {@code targetClass}.
    541. 

  541.      */
    542. 

  542.     <T> T get(int i, Class<T> targetClass);
    543. 

  543. 

  544.     /**
    545. 

  545.      * Returns the {@code i}th value converted to the given Java type.
    546. 

  546.      *
    547. 

  547.      * <p>This method uses the {@link CodecRegistry} to find a codec to convert the underlying CQL
    548. 

  548.      * type to the given Java type.
    549. 

  549.      *
    550. 

  550.      * <p>Implementation note: the actual object returned by this method will depend on the {@link
    551. 

  551.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    552. 

  552.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    553. 

  553.      * {@code NULL} values is also codec-dependent; by default, a CQL {@code NULL} value translates to
    554. 

  554.      * {@code null} for simple CQL types, UDTs and tuples, and to empty collections for all CQL
    555. 

  555.      * collection types.
    556. 

  556.      *
    557. 

  557.      * @param i          the index to retrieve.
    558. 

  558.      * @param targetType The Java type the value should be converted to.
    559. 

  559.      * @return the value of the {@code i}th value converted to the given Java type.
    560. 

  560.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    561. 

  561.      * @throws CodecNotFoundException    if there is no registered codec to convert the element's CQL
    562. 

  562.      *                                   type to {@code targetType}.
    563. 

  563.      */
    564. 

  564.     <T> T get(int i, TypeToken<T> targetType);
    565. 

  565. 

  566.     /**
    567. 

  567.      * Returns the {@code i}th value converted using the given {@link TypeCodec}.
    568. 

  568.      *
    569. 

  569.      * <p>This method entirely bypasses the {@link CodecRegistry} and forces the driver to use the
    570. 

  570.      * given codec instead. This can be useful if the codec would collide with a previously registered
    571. 

  571.      * one, or if you want to use the codec just once without registering it.
    572. 

  572.      *
    573. 

  573.      * <p>It is the caller's responsibility to ensure that the given codec {@link
    574. 

  574.      * TypeCodec#accepts(DataType) accepts} the underlying CQL type; failing to do so may result in
    575. 

  575.      * {@link InvalidTypeException}s being thrown.
    576. 

  576.      *
    577. 

  577.      * <p>Implementation note: the actual object returned by this method will depend on the {@link
    578. 

  578.      * TypeCodec codec} being used; therefore, callers should make no assumptions concerning its
    579. 

  579.      * mutability nor its thread-safety. Furthermore, the behavior of this method in respect to CQL
    580. 

  580.      * {@code NULL} values is also codec-dependent; by default, a CQL {@code NULL} value translates to
    581. 

  581.      * {@code null} for simple CQL types, UDTs and tuples, and to empty collections for all CQL
    582. 

  582.      * collection types.
    583. 

  583.      *
    584. 

  584.      * @param i     the index to retrieve.
    585. 

  585.      * @param codec The {@link TypeCodec} to use to deserialize the value; may not be {@code null}.
    586. 

  586.      * @return the value of the {@code i}th value converted using the given {@link TypeCodec}.
    587. 

  587.      * @throws InvalidTypeException      if the given codec does not {@link TypeCodec#accepts(DataType)
    588. 

  588.      *                                   accept} the underlying CQL type.
    589. 

  589.      * @throws IndexOutOfBoundsException if {@code i} is not a valid index for this object.
    590. 

  590.      */
    591. 

  591.     <T> T get(int i, TypeCodec<T> codec);
    592. 

  592. }
    593.