docs: make sure clients know about APIs that are exposed to them but …

…not available

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/metadata/TgTableMetadata.java

@@ -26,22 +26,22 @@ public TgTableMetadata(TableMetadata lowTableMetadata) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get database name.
      *
      * @return database name
      */
-    @Nullable
-    public String getDatabaseName() {
+    public @Nullable String getDatabaseName() {
         return lowTableMetadata.getDatabaseName().orElse(null);
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get schema name.
      *
      * @return schema name
      */
-    @Nullable
-    public String getSchemaName() {
+    public @Nullable String getSchemaName() {
         return lowTableMetadata.getSchemaName().orElse(null);
     }
 
@@ -50,8 +50,7 @@ public String getSchemaName() {
      *
      * @return table name
      */
-    @Nonnull
-    public String getTableName() {
+    public @Nonnull String getTableName() {
         return lowTableMetadata.getTableName();
     }
 

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/result/TsurugiResultIndexEntity.java

@@ -425,6 +425,7 @@ public default byte[] getBytes(int index, byte[] defaultValue) {
     // boolean[]
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param index column index
@@ -437,6 +438,7 @@ public default byte[] getBytes(int index, byte[] defaultValue) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param index        column index
@@ -449,6 +451,7 @@ public default boolean[] getBits(int index, boolean[] defaultValue) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param index column index
@@ -460,6 +463,7 @@ public default boolean[] getBits(int index, boolean[] defaultValue) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param index column index

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/result/TsurugiResultNameEntity.java

@@ -425,6 +425,7 @@ public default byte[] getBytes(String name, byte[] defaultValue) {
     // boolean[]
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param name column name
@@ -437,6 +438,7 @@ public default byte[] getBytes(String name, byte[] defaultValue) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param name         column name
@@ -449,6 +451,7 @@ public default boolean[] getBits(String name, boolean[] defaultValue) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param name column name
@@ -460,6 +463,7 @@ public default boolean[] getBits(String name, boolean[] defaultValue) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param name column name

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/TgDataType.java

@@ -53,6 +53,7 @@ public enum TgDataType {
      */
     BYTES(AtomType.OCTET, List.of(byte[].class)),
     /**
+     * <em>This enum is not yet implemented:</em>
      * boolean[]
      */
     BITS(AtomType.BIT, List.of(boolean[].class)),

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/TsurugiSqlPreparedStatement.java

@@ -131,6 +131,7 @@ public TsurugiStatementResult execute(TsurugiTransaction transaction, P paramete
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * execute batch.
      *
      * @param transaction   Transaction

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/parameter/TgBindParameters.java

@@ -265,6 +265,7 @@ public TgBindParameters addBytes(@Nonnull String name, @Nullable byte[] value) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add value(boolean[]).
      *
      * @param name  name
@@ -517,6 +518,7 @@ public TgBindParameters add(@Nonnull String name, @Nullable byte[] value) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add value(boolean[]).
      *
      * @param name  name

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/parameter/TgBindVariable.java

@@ -464,6 +464,7 @@ public TgBindVariableBytes clone(@Nonnull String name) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * create bind variable.
      *
      * @param name name
@@ -474,6 +475,7 @@ public static TgBindVariable<boolean[]> ofBits(@Nonnull String name) {
     }
 
     /**
+     * <em>This class is not yet implemented:</em>
      * Tsurugi Bind Variable&lt;boolean[]&gt;.
      */
     public static class TgBindVariableBits extends TgBindVariable<boolean[]> {

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/parameter/TgBindVariables.java

@@ -210,6 +210,7 @@ public TgBindVariables addBytes(@Nonnull String name) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add type(boolean[]).
      *
      * @param name name

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/parameter/mapping/TgEntityParameterMapping.java

@@ -321,6 +321,7 @@ public <V> TgEntityParameterMapping<P> addBytes(String name, Function<P, V> gett
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add variable.
      *
      * @param name   name
@@ -337,6 +338,7 @@ public TgEntityParameterMapping<P> addBits(String name, Function<P, boolean[]> g
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add variable.
      *
      * @param <V>       value type

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/parameter/mapping/TgSingleParameterMapping.java

@@ -133,6 +133,7 @@ public static TgSingleParameterMapping<byte[]> ofBytes(String name) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * create parameter mapping.
      *
      * @param name bind variable name

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/result/TsurugiResultIndexRecord.java

@@ -526,6 +526,7 @@ public default byte[] getBytes(int index, byte[] defaultValue) throws IOExceptio
     // boolean[]
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param index column index
@@ -541,6 +542,7 @@ public default byte[] getBytes(int index, byte[] defaultValue) throws IOExceptio
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param index        column index
@@ -556,6 +558,7 @@ public default boolean[] getBits(int index, boolean[] defaultValue) throws IOExc
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param index column index
@@ -570,6 +573,7 @@ public default boolean[] getBits(int index, boolean[] defaultValue) throws IOExc
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param index column index

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/result/TsurugiResultNameRecord.java

@@ -526,6 +526,7 @@ public default byte[] getBytes(String name, byte[] defaultValue) throws IOExcept
     // boolean[]
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param name column name
@@ -541,6 +542,7 @@ public default byte[] getBytes(String name, byte[] defaultValue) throws IOExcept
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param name         column name
@@ -556,6 +558,7 @@ public default boolean[] getBits(String name, boolean[] defaultValue) throws IOE
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param name column name
@@ -570,6 +573,7 @@ public default boolean[] getBits(String name, boolean[] defaultValue) throws IOE
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get value as boolean[].
      *
      * @param name column name

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/result/TsurugiResultNextRecord.java

@@ -502,6 +502,7 @@ public default byte[] nextBytes(byte[] defaultValue) throws IOException, Interru
     // boolean[]
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get current value as boolean[] and move next column.
      *
      * @return value
@@ -516,6 +517,7 @@ public default byte[] nextBytes(byte[] defaultValue) throws IOException, Interru
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get current value as boolean[] and move next column.
      *
      * @param defaultValue value to return if original value is null
@@ -530,6 +532,7 @@ public default boolean[] nextBits(boolean[] defaultValue) throws IOException, In
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get current value as boolean[] and move next column.
      *
      * @return value
@@ -543,6 +546,7 @@ public default boolean[] nextBits(boolean[] defaultValue) throws IOException, In
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * get current value as boolean[] and move next column.
      *
      * @return value

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/result/mapping/TgEntityResultMapping.java

@@ -749,6 +749,7 @@ public <V> TgEntityResultMapping<R> addBytes(String name, BiConsumer<R, V> sette
     // boolean[]
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add setter.
      *
      * @param setter setter to R
@@ -760,6 +761,7 @@ public TgEntityResultMapping<R> addBits(BiConsumer<R, boolean[]> setter) {
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add setter.
      *
      * @param <V>       value type
@@ -773,6 +775,7 @@ public <V> TgEntityResultMapping<R> addBits(BiConsumer<R, V> setter, Function<bo
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add setter.
      *
      * @param index  column index
@@ -785,6 +788,7 @@ public TgEntityResultMapping<R> addBits(int index, BiConsumer<R, boolean[]> sett
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add setter.
      *
      * @param <V>       value type
@@ -801,6 +805,7 @@ public <V> TgEntityResultMapping<R> addBits(int index, BiConsumer<R, V> setter,
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add setter.
      *
      * @param name   column name
@@ -813,6 +818,7 @@ public TgEntityResultMapping<R> addBits(String name, BiConsumer<R, boolean[]> se
     }
 
     /**
+     * <em>This method is not yet implemented:</em>
      * add setter.
      *
      * @param <V>       value type

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/sql/result/mapping/TgSingleResultMapping.java

@@ -139,6 +139,7 @@ public static TgSingleResultMapping<byte[]> ofBytes() {
     private static TgSingleResultMapping<boolean[]> bitsMapping;
 
     /**
+     * <em>This method is not yet implemented:</em>
      * create result mapping.
      *
      * @return result mapping

modules/iceaxe-core/src/main/java/com/tsurugidb/iceaxe/transaction/option/AbstractTgTxOptionLong.java

@@ -19,6 +19,7 @@ public abstract class AbstractTgTxOptionLong<T extends AbstractTgTxOptionLong<T>
     private TransactionPriority lowPriority = null;
 
     /**
+     * <em>This method is not yet implemented:</em>
      * set priority.
      *
      * @param priority priority