Added interfaces for new query attributes classes.

Author: fjssilva

src/main/core-api/java/com/mysql/cj/QueryAttributesBindValue.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright (c) 2021, Oracle and/or its affiliates.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 2.0, as published by the
+ * Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including but not
+ * limited to OpenSSL) that is licensed under separate terms, as designated in a
+ * particular file or component or in included license documentation. The
+ * authors of MySQL hereby grant you an additional permission to link the
+ * program and your derivative works with the separately licensed software that
+ * they have included with MySQL.
+ *
+ * Without limiting anything contained in the foregoing, this file, which is
+ * part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
+ * version 1.0, a copy of which can be found at
+ * http://oss.oracle.com/licenses/universal-foss-exception.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0,
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+package com.mysql.cj;
+
+/**
+ * An internal representation of a query attribute bind value.
+ * 
+ */
+public interface QueryAttributesBindValue {
+    /**
+     * Checks whether this query attribute is the <code>null</code> value.
+     * 
+     * @return
+     *         <code>true</code> if this query attribute value is <code>null</code>.
+     */
+    boolean isNull();
+
+    /**
+     * Gets the name of this query attribute.
+     * 
+     * @return
+     *         the name of this query attribute.
+     */
+    String getName();
+
+    /**
+     * Gets the type of this query attribute. Query attributes types are one of the {@link MysqlType}.FIELD_TYPE_*.
+     * 
+     * @return
+     *         the type of this query attribute.
+     */
+    int getType();
+
+    /**
+     * Gets the value of this query attribute.
+     * 
+     * @return
+     *         the value of this query attribute.
+     */
+    Object getValue();
+
+    /**
+     * Gets the length of this query attribute.
+     * 
+     * @return
+     *         the expected length, in Bytes, of this query attribute value after being encoded.
+     */
+    long getBoundLength();
+}

src/main/core-api/java/com/mysql/cj/QueryAttributesBindings.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright (c) 2021, Oracle and/or its affiliates.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, version 2.0, as published by the
+ * Free Software Foundation.
+ *
+ * This program is also distributed with certain software (including but not
+ * limited to OpenSSL) that is licensed under separate terms, as designated in a
+ * particular file or component or in included license documentation. The
+ * authors of MySQL hereby grant you an additional permission to link the
+ * program and your derivative works with the separately licensed software that
+ * they have included with MySQL.
+ *
+ * Without limiting anything contained in the foregoing, this file, which is
+ * part of MySQL Connector/J, is also subject to the Universal FOSS Exception,
+ * version 1.0, a copy of which can be found at
+ * http://oss.oracle.com/licenses/universal-foss-exception.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License, version 2.0,
+ * for more details.
+ *
+ * You should have received a copy of the GNU General Public License along with
+ * this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
+ */
+
+package com.mysql.cj;
+
+import java.sql.Statement;
+import java.util.function.Consumer;
+
+/**
+ * Instances of this interface keep the list of query attributes assigned to a {@link Statement} object.
+ */
+public interface QueryAttributesBindings {
+    /**
+     * Adds a new query attribute to the list of query attributes. Implementations must validate the type of the given the object and reject it or replace it by
+     * another representation if not supported, by its String version, for example. Query attribute names are not checked for duplication.
+     * 
+     * @param name
+     *            the query attribute name.
+     * 
+     * @param value
+     *            the query attribute value.
+     */
+    void setAttribute(String name, Object value);
+
+    /**
+     * Get the count of query attributes in the list.
+     * 
+     * @return
+     *         the number of query attributes existing in the list.
+     */
+    int getCount();
+
+    /**
+     * Returns an internal representation of the query attribute in the given position of the query attributes list. It's implementation dependent what to do
+     * when the index value is invalid.
+     * 
+     * @param index
+     *            the position of the query attribute value to return.
+     * 
+     * @return
+     *         the {@link QueryAttributesBindValue} in the given position of the query attributes list.
+     */
+    QueryAttributesBindValue getAttributeValue(int index);
+
+    /**
+     * Runs through all query attributes while feeding the given {@link Consumer} with each one of them.
+     * 
+     * @param bindAttribute
+     *            A {@link Consumer} for each one of the single query attributes.
+     */
+    void runThroughAll(Consumer<QueryAttributesBindValue> bindAttribute);
+
+    /**
+     * Removes all query attributes from the query attributes list.
+     */
+    void clearAttributes();
+}

src/main/core-impl/java/com/mysql/cj/AbstractQuery.java

@@ -98,7 +98,7 @@ public AbstractQuery(NativeSession sess) {
         this.session = sess;
         this.maxAllowedPacket = sess.getPropertySet().getIntegerProperty(PropertyKey.maxAllowedPacket);
         this.charEncoding = sess.getPropertySet().getStringProperty(PropertyKey.characterEncoding).getValue();
-        this.queryAttributesBindings = new QueryAttributesBindings();
+        this.queryAttributesBindings = new NativeQueryAttributesBindings();
     }
 
     @Override

src/main/core-impl/java/com/mysql/cj/QueryAttributesBindValue.java renamed to src/main/core-impl/java/com/mysql/cj/NativeQueryAttributesBindValue.java

@@ -44,9 +44,8 @@
 import java.util.Optional;
 
 import com.mysql.cj.protocol.a.NativeConstants;
-import com.mysql.cj.util.StringUtils;
 
-public class QueryAttributesBindValue {
+public class NativeQueryAttributesBindValue implements QueryAttributesBindValue {
     private static final Map<Class<?>, Integer> JAVA_TO_MYSQL_FIELD_TYPE = new HashMap<>();
     static {
         JAVA_TO_MYSQL_FIELD_TYPE.put(String.class, MysqlType.FIELD_TYPE_STRING);
@@ -83,7 +82,7 @@ public class QueryAttributesBindValue {
     /** The attribute MySQL type */
     protected int type = MysqlType.FIELD_TYPE_NULL;
 
-    protected QueryAttributesBindValue(String name, Object value) {
+    protected NativeQueryAttributesBindValue(String name, Object value) {
         this.name = name;
         this.value = value;
         this.type = getMysqlFieldType(value);
@@ -109,27 +108,27 @@ private int getMysqlFieldType(Object obj) {
         return MysqlType.FIELD_TYPE_STRING;
     }
 
+    @Override
     public boolean isNull() {
         return this.type == MysqlType.FIELD_TYPE_NULL;
     }
 
+    @Override
     public String getName() {
         return this.name;
     }
 
+    @Override
     public int getType() {
         return this.type;
     }
 
+    @Override
     public Object getValue() {
         return this.value;
     }
 
-    public byte[] getByteValue() {
-        String charEncoding = null;
-        return charEncoding != null ? StringUtils.getBytes(toString(), charEncoding) : toString().getBytes();
-    }
-
+    @Override
     public long getBoundLength() {
         if (isNull()) {
             return 0;

src/main/core-impl/java/com/mysql/cj/QueryAttributesBindings.java renamed to src/main/core-impl/java/com/mysql/cj/NativeQueryAttributesBindings.java

@@ -33,28 +33,33 @@
 import java.util.List;
 import java.util.function.Consumer;
 
-public class QueryAttributesBindings {
-    private List<QueryAttributesBindValue> bindAttributes = new ArrayList<>();
+public class NativeQueryAttributesBindings implements QueryAttributesBindings {
+    private List<NativeQueryAttributesBindValue> bindAttributes = new ArrayList<>();
 
-    public QueryAttributesBindings() {
+    public NativeQueryAttributesBindings() {
     }
 
+    @Override
     public void setAttribute(String name, Object value) {
-        this.bindAttributes.add(new QueryAttributesBindValue(name, value));
+        this.bindAttributes.add(new NativeQueryAttributesBindValue(name, value));
     }
 
+    @Override
     public int getCount() {
         return this.bindAttributes.size();
     }
 
+    @Override
     public QueryAttributesBindValue getAttributeValue(int index) {
         return this.bindAttributes.get(index);
     }
 
+    @Override
     public void runThroughAll(Consumer<QueryAttributesBindValue> bindAttribute) {
         this.bindAttributes.forEach(bindAttribute::accept);
     }
 
+    @Override
     public void clearAttributes() {
         this.bindAttributes.clear();
     }

src/main/doc/mysqlx-overview.html

@@ -1,6 +1,6 @@
 <body>
   <h1>MySQL Connector/J X DevAPI Reference</h1>
-  <p/>
+  <p></p>
 
   This documentation covers the public classes and interfaces of the Java implementation of the X DevAPI. To get started, check out some of the main classes: