* Alternatively, the host, port, and service name may be specified using an - * + * * Oracle Net Descriptor. The descriptor may be set as the value of an * {@link Option} having the name "descriptor". When the descriptor option is * present, the JDBC URL is composed as: diff --git a/src/main/java/oracle/r2dbc/impl/OracleReadableImpl.java b/src/main/java/oracle/r2dbc/impl/OracleReadableImpl.java index 3288860..d00dbef 100755 --- a/src/main/java/oracle/r2dbc/impl/OracleReadableImpl.java +++ b/src/main/java/oracle/r2dbc/impl/OracleReadableImpl.java @@ -71,9 +71,9 @@ class OracleReadableImpl implements io.r2dbc.spi.Readable { * {@code jdbcReadable} and obtains metadata of the values from * {@code resultMetadata}. *
- * @param jdbcReadable Readable values from a JDBC Driver. - * @param readablesMetadata Metadata of each value - * @param adapter Adapts JDBC calls into reactive streams. + * @param jdbcReadable Readable values from a JDBC Driver. Not null. + * @param readablesMetadata Metadata of each value. Not null. + * @param adapter Adapts JDBC calls into reactive streams. Not null. */ private OracleReadableImpl( JdbcReadable jdbcReadable, ReadablesMetadata readablesMetadata, @@ -89,9 +89,11 @@ private OracleReadableImpl( * provided {@code jdbcReadable} and {@code metadata}. The metadata * object is used to determine the default type mapping of column values. * - * @param adapter Adapts JDBC calls into reactive streams. - * @param jdbcReadable Row data from the Oracle JDBC Driver. - * @param metadata Meta-data for the specified row. + * @param jdbcReadable Row data from the Oracle JDBC Driver. Not null. + * @param metadata Meta-data for the specified row. Not null. + * @param adapter Adapts JDBC calls into reactive streams. Not null. + * @return A {@code Row} backed by the {@code jdbcReadable} and + * {@code metadata}. Not null. */ static Row createRow( JdbcReadable jdbcReadable, RowMetadataImpl metadata, @@ -104,9 +106,11 @@ static Row createRow( * the provided {@code jdbcReadable} and {@code rowMetadata}. The metadata * object is used to determine the default type mapping of column values. * - * @param adapter Adapts JDBC calls into reactive streams. - * @param jdbcReadable Row data from the Oracle JDBC Driver. - * @param metadata Meta-data for the specified row. + * @param jdbcReadable Row data from the Oracle JDBC Driver. Not null. + * @param metadata Meta-data for the specified row. Not null. + * @param adapter Adapts JDBC calls into reactive streams. Not null. + * @return An {@code OutParameters} backed by the {@code jdbcReadable} and + * {@code metadata}. Not null. */ static OutParameters createOutParameters( JdbcReadable jdbcReadable, OutParametersMetadataImpl metadata, @@ -160,7 +164,7 @@ public* Implements the R2DBC SPI method by returning the R2DBC {@code Type}. *
- * @return */ @Override public Type getType() { @@ -532,4 +531,4 @@ public int hashCode() { } } -} \ No newline at end of file +} diff --git a/src/main/java/oracle/r2dbc/impl/OracleResultImpl.java b/src/main/java/oracle/r2dbc/impl/OracleResultImpl.java index bd8ebf8..7218ef8 100644 --- a/src/main/java/oracle/r2dbc/impl/OracleResultImpl.java +++ b/src/main/java/oracle/r2dbc/impl/OracleResultImpl.java @@ -95,7 +95,7 @@ private OracleResultImpl() { } /** * Publishes the output of a {@code mappingFunction} for each {@code Segment} * of this {@code Result}. - * @param mappingFunction {@code Segment} mapping function. + * @param mappingFunction {@code Segment} mapping function. Not null. * @param+ ** SELECT name FROM birthday WHERE month=:x AND day=:x *- * * @throws IllegalArgumentException {@inheritDoc} * @throws IllegalArgumentException If the {@code identifier} does match a * case sensitive parameter name that appears in this {@code Statement's} @@ -348,17 +347,15 @@ public Statement bindNull(int index, Class type) { * SQL command is read from left to right. (Note: It is not recommended to use * duplicate parameter names. Use {@link #bindNull(int, Class)} to set the * SQL {@code NULL} value for a duplicate parameter name at a given index). - * ** If the specified {@code identifier} matches more than one parameter name, * then this method binds the SQL {@code NULL} value to all parameters * having a matching name. For instance, when {@code NULL} is bound to the * parameter named "x", the following SQL would create a birthday with * {@code NULL} values for month and day: - *
+ ** INSERT INTO birthday (name, month, day) VALUES ('Plato', :x, :x) *- * * @throws IllegalArgumentException {@inheritDoc} * @throws IllegalArgumentException If the {@code identifier} does match a * case sensitive parameter name that appears in this {@code Statement's} @@ -1590,4 +1587,4 @@ protected PublisherexecuteJdbc() { } } -} \ No newline at end of file +} diff --git a/src/main/java/oracle/r2dbc/impl/SqlTypeMap.java b/src/main/java/oracle/r2dbc/impl/SqlTypeMap.java index b0ecd74..231c1fd 100644 --- a/src/main/java/oracle/r2dbc/impl/SqlTypeMap.java +++ b/src/main/java/oracle/r2dbc/impl/SqlTypeMap.java @@ -232,18 +232,18 @@ static SQLType toJdbcType(Type r2dbcType) { * that SQL type. Where the specification defines a Java type that maps to * multiple SQL types, the return value of this method is as follows: * - *
* This method returns non-standard SQL types supported by Oracle * Database for the following Java types: *- {@link String} -> VARCHAR
- *- {@link ByteBuffer} -> VARBINARY
+ *- {@link String} : VARCHAR
+ *- {@link ByteBuffer} : VARBINARY
*- *
* @param javaType Java type to map * @return SQL type mapping for the {@code javaType} diff --git a/src/main/java/oracle/r2dbc/impl/package-info.java b/src/main/java/oracle/r2dbc/impl/package-info.java index 82b13b9..39eef5b 100644 --- a/src/main/java/oracle/r2dbc/impl/package-info.java +++ b/src/main/java/oracle/r2dbc/impl/package-info.java @@ -27,6 +27,11 @@ * developers should program against the io.r2dbc.spi interfaces only, without * referencing any classes defined in this package. *- {@link Double} -> BINARY_DOUBLE
- *- {@link Float} -> BINARY_FLOAT
- *- {@link Duration} -> INTERVAL DAY TO SECOND
- *- {@link Period} -> INTERVAL YEAR TO MONTH
- *- {@link RowId} -> ROWID
- *- {@link OracleJsonObject} -> JSON
+ *- {@link Double} : BINARY_DOUBLE
+ *- {@link Float} : BINARY_FLOAT
+ *- {@link Duration} : INTERVAL DAY TO SECOND
+ *- {@link Period} : INTERVAL YEAR TO MONTH
+ *- {@link RowId} : ROWID
+ *- {@link OracleJsonObject} : JSON
*+ * + * The API defined by this package is not stable. It may change between + * releases of Oracle R2DBC. + * + *
* {@link oracle.r2dbc.impl.ReactiveJdbcAdapter} defines a reactive interface * to be implemented using any non-standard APIs that a JDBC driver may provide * for asynchronous database access. The Oracle R2DBC Driver relies on an diff --git a/src/main/java/oracle/r2dbc/package-info.java b/src/main/java/oracle/r2dbc/package-info.java new file mode 100644 index 0000000..ce01e2d --- /dev/null +++ b/src/main/java/oracle/r2dbc/package-info.java @@ -0,0 +1,30 @@ +/* + Copyright (c) 2020, 2022, Oracle and/or its affiliates. + + This software is dual-licensed to you under the Universal Permissive License + (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License + 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose + either license. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +*/ + +/** + *
+ * Extensions to the standard R2DBC SPI for the Oracle Database. The API of this + * package is intended for consumption by external code bases. This API may be + * used to access functions of Oracle Database which are not offered by the + * standard R2DBC SPI. + *
+ */ +package oracle.r2dbc;