diff --git a/.github/workflows/java.yml b/.github/workflows/java.yml index 7c3c6b7ba..4a8b0310d 100644 --- a/.github/workflows/java.yml +++ b/.github/workflows/java.yml @@ -32,7 +32,7 @@ jobs: uses: actions/setup-java@v3 with: distribution: 'temurin' - java-version: '11' + java-version: '17' - name: Run Java tests run: make test diff --git a/bindings/java/NOTICE.md b/bindings/java/NOTICE.md new file mode 100644 index 000000000..666b06930 --- /dev/null +++ b/bindings/java/NOTICE.md @@ -0,0 +1,19 @@ +Limbo +======= + +Please visit out github for more information: + +* https://github.com/tursodatabase/limbo + +Dependencies +============ + +This product depends on Error Prone, distributed by the Error Prone project: + +* License: licenses/assertj-license.md (Apache License v2.0) +* Homepage: https://github.com/google/error-prone + +This product depends on AssertJ, distributed by the AssertJ authors: + +* License: licenses/errorprone-license.md (Apache License v2.0) +* Homepage: https://joel-costigliola.github.io/assertj/ diff --git a/bindings/java/build.gradle.kts b/bindings/java/build.gradle.kts index f1349859d..9936bec60 100644 --- a/bindings/java/build.gradle.kts +++ b/bindings/java/build.gradle.kts @@ -1,16 +1,28 @@ +import net.ltgt.gradle.errorprone.CheckSeverity +import net.ltgt.gradle.errorprone.errorprone + plugins { java application + id("net.ltgt.errorprone") version "4.1.0" } group = "org.github.tursodatabase" version = "0.0.1-SNAPSHOT" +java { + sourceCompatibility = JavaVersion.VERSION_17 + targetCompatibility = JavaVersion.VERSION_17 +} + repositories { mavenCentral() } dependencies { + errorprone("com.uber.nullaway:nullaway:0.12.3") + errorprone("com.google.errorprone:error_prone_core:2.36.0") + testImplementation(platform("org.junit:junit-bom:5.10.0")) testImplementation("org.junit.jupiter:junit-jupiter") testImplementation("org.assertj:assertj-core:3.27.0") @@ -30,5 +42,27 @@ application { tasks.test { useJUnitPlatform() // In order to find rust built file under resources, we need to set it as system path - systemProperty("java.library.path", "${System.getProperty("java.library.path")}:$projectDir/src/test/resources/limbo/debug") + systemProperty( + "java.library.path", + "${System.getProperty("java.library.path")}:$projectDir/src/test/resources/limbo/debug" + ) +} + +tasks.withType { + options.errorprone { + // Let's select which checks to perform. NullAway is enough for now. + disableAllChecks = true + check("NullAway", CheckSeverity.ERROR) + + option("NullAway:AnnotatedPackages", "org.github.tursodatabase") + option( + "NullAway:CustomNullableAnnotations", + "org.github.tursodatabase.annotations.Nullable,org.github.tursodatabase.annotations.SkipNullableCheck" + ) + } + if (name.lowercase().contains("test")) { + options.errorprone { + disable("NullAway") + } + } } diff --git a/bindings/java/licenses/assertj-license.md b/bindings/java/licenses/assertj-license.md new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/bindings/java/licenses/assertj-license.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. diff --git a/bindings/java/licenses/errorprone-license.md b/bindings/java/licenses/errorprone-license.md new file mode 100644 index 000000000..261eeb9e9 --- /dev/null +++ b/bindings/java/licenses/errorprone-license.md @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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 + + http://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. diff --git a/bindings/java/src/main/java/org/github/tursodatabase/JDBC.java b/bindings/java/src/main/java/org/github/tursodatabase/JDBC.java index a341f032a..0b2196058 100644 --- a/bindings/java/src/main/java/org/github/tursodatabase/JDBC.java +++ b/bindings/java/src/main/java/org/github/tursodatabase/JDBC.java @@ -1,8 +1,11 @@ package org.github.tursodatabase; +import org.github.tursodatabase.annotations.Nullable; +import org.github.tursodatabase.annotations.SkipNullableCheck; import org.github.tursodatabase.jdbc4.JDBC4Connection; import java.sql.*; +import java.util.Locale; import java.util.Properties; import java.util.logging.Logger; @@ -17,6 +20,7 @@ public class JDBC implements Driver { } } + @Nullable public static LimboConnection createConnection(String url, Properties properties) throws SQLException { if (!isValidURL(url)) return null; @@ -25,13 +29,14 @@ public class JDBC implements Driver { } private static boolean isValidURL(String url) { - return url != null && url.toLowerCase().startsWith(VALID_URL_PREFIX); + return url != null && url.toLowerCase(Locale.ROOT).startsWith(VALID_URL_PREFIX); } private static String extractAddress(String url) { return url.substring(VALID_URL_PREFIX.length()); } + @Nullable @Override public Connection connect(String url, Properties info) throws SQLException { return createConnection(url, info); @@ -65,6 +70,7 @@ public class JDBC implements Driver { } @Override + @SkipNullableCheck public Logger getParentLogger() throws SQLFeatureNotSupportedException { // TODO return null; diff --git a/bindings/java/src/main/java/org/github/tursodatabase/LimboDataSource.java b/bindings/java/src/main/java/org/github/tursodatabase/LimboDataSource.java index 12a53c303..ff98ec651 100644 --- a/bindings/java/src/main/java/org/github/tursodatabase/LimboDataSource.java +++ b/bindings/java/src/main/java/org/github/tursodatabase/LimboDataSource.java @@ -1,5 +1,8 @@ package org.github.tursodatabase; +import org.github.tursodatabase.annotations.Nullable; +import org.github.tursodatabase.annotations.SkipNullableCheck; + import javax.sql.DataSource; import java.io.PrintWriter; import java.sql.Connection; @@ -27,19 +30,21 @@ public class LimboDataSource implements DataSource { } @Override + @Nullable public Connection getConnection() throws SQLException { return getConnection(null, null); } @Override - public Connection getConnection(String username, String password) throws SQLException { + @Nullable + public Connection getConnection(@Nullable String username, @Nullable String password) throws SQLException { Properties properties = limboConfig.toProperties(); if (username != null) properties.put("user", username); if (password != null) properties.put("pass", password); return JDBC.createConnection(url, properties); } - @Override + @SkipNullableCheck public PrintWriter getLogWriter() throws SQLException { // TODO return null; @@ -62,12 +67,14 @@ public class LimboDataSource implements DataSource { } @Override + @SkipNullableCheck public Logger getParentLogger() throws SQLFeatureNotSupportedException { // TODO return null; } @Override + @SkipNullableCheck public T unwrap(Class iface) throws SQLException { // TODO return null; diff --git a/bindings/java/src/main/java/org/github/tursodatabase/NativeInvocation.java b/bindings/java/src/main/java/org/github/tursodatabase/annotations/NativeInvocation.java similarity index 88% rename from bindings/java/src/main/java/org/github/tursodatabase/NativeInvocation.java rename to bindings/java/src/main/java/org/github/tursodatabase/annotations/NativeInvocation.java index 70fd6c100..d3a905608 100644 --- a/bindings/java/src/main/java/org/github/tursodatabase/NativeInvocation.java +++ b/bindings/java/src/main/java/org/github/tursodatabase/annotations/NativeInvocation.java @@ -1,4 +1,4 @@ -package org.github.tursodatabase; +package org.github.tursodatabase.annotations; import java.lang.annotation.ElementType; diff --git a/bindings/java/src/main/java/org/github/tursodatabase/annotations/Nullable.java b/bindings/java/src/main/java/org/github/tursodatabase/annotations/Nullable.java new file mode 100644 index 000000000..88451f8b4 --- /dev/null +++ b/bindings/java/src/main/java/org/github/tursodatabase/annotations/Nullable.java @@ -0,0 +1,18 @@ +package org.github.tursodatabase.annotations; + + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Annotation to mark nullable types. + *

+ * This annotation is used to indicate that a method, field, or parameter can be null. + * It helps in identifying potential nullability issues and improving code quality. + */ +@Retention(RetentionPolicy.SOURCE) +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}) +public @interface Nullable { +} diff --git a/bindings/java/src/main/java/org/github/tursodatabase/annotations/SkipNullableCheck.java b/bindings/java/src/main/java/org/github/tursodatabase/annotations/SkipNullableCheck.java new file mode 100644 index 000000000..69214e7c4 --- /dev/null +++ b/bindings/java/src/main/java/org/github/tursodatabase/annotations/SkipNullableCheck.java @@ -0,0 +1,18 @@ +package org.github.tursodatabase.annotations; + + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * Marker annotation to skip nullable checks. + *

+ * This annotation is used to mark methods, fields, or parameters that should be excluded from nullable checks. + * It is typically applied to code that is still under development or requires special handling. + */ +@Retention(RetentionPolicy.SOURCE) +@Target({ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER}) +public @interface SkipNullableCheck { +} diff --git a/bindings/java/src/main/java/org/github/tursodatabase/VisibleForTesting.java b/bindings/java/src/main/java/org/github/tursodatabase/annotations/VisibleForTesting.java similarity index 88% rename from bindings/java/src/main/java/org/github/tursodatabase/VisibleForTesting.java rename to bindings/java/src/main/java/org/github/tursodatabase/annotations/VisibleForTesting.java index 1afd119c3..5f8d30458 100644 --- a/bindings/java/src/main/java/org/github/tursodatabase/VisibleForTesting.java +++ b/bindings/java/src/main/java/org/github/tursodatabase/annotations/VisibleForTesting.java @@ -1,4 +1,4 @@ -package org.github.tursodatabase; +package org.github.tursodatabase.annotations; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; diff --git a/bindings/java/src/main/java/org/github/tursodatabase/core/LimboDB.java b/bindings/java/src/main/java/org/github/tursodatabase/core/LimboDB.java index accbad76b..da829da63 100644 --- a/bindings/java/src/main/java/org/github/tursodatabase/core/LimboDB.java +++ b/bindings/java/src/main/java/org/github/tursodatabase/core/LimboDB.java @@ -2,8 +2,9 @@ package org.github.tursodatabase.core; import org.github.tursodatabase.LimboErrorCode; -import org.github.tursodatabase.NativeInvocation; -import org.github.tursodatabase.VisibleForTesting; +import org.github.tursodatabase.annotations.NativeInvocation; +import org.github.tursodatabase.annotations.VisibleForTesting; +import org.github.tursodatabase.annotations.Nullable; import org.github.tursodatabase.exceptions.LimboException; import java.nio.charset.StandardCharsets; @@ -82,9 +83,15 @@ public final class LimboDB extends AbstractDB { @Override protected void open0(String fileName, int openFlags) throws SQLException { if (isOpen) { - throwLimboException(LimboErrorCode.UNKNOWN_ERROR.code, "Already opened"); + throw buildLimboException(LimboErrorCode.ETC.code, "Already opened"); } - dbPtr = openUtf8(stringToUtf8ByteArray(fileName), openFlags); + + byte[] fileNameBytes = stringToUtf8ByteArray(fileName); + if (fileNameBytes == null) { + throw buildLimboException(LimboErrorCode.ETC.code, "File name cannot be converted to byteArray. File name: " + fileName); + } + + dbPtr = openUtf8(fileNameBytes, openFlags); isOpen = true; } @@ -114,7 +121,7 @@ public final class LimboDB extends AbstractDB { @NativeInvocation private void throwLimboException(int errorCode, byte[] errorMessageBytes) throws SQLException { String errorMessage = utf8ByteBufferToString(errorMessageBytes); - throwLimboException(errorCode, errorMessage); + throw buildLimboException(errorCode, errorMessage); } /** @@ -123,7 +130,7 @@ public final class LimboDB extends AbstractDB { * @param errorCode Error code. * @param errorMessage Error message. */ - public void throwLimboException(int errorCode, String errorMessage) throws SQLException { + public LimboException buildLimboException(int errorCode, @Nullable String errorMessage) throws SQLException { LimboErrorCode code = LimboErrorCode.getErrorCode(errorCode); String msg; if (code == LimboErrorCode.UNKNOWN_ERROR) { @@ -132,10 +139,11 @@ public final class LimboDB extends AbstractDB { msg = String.format("%s (%s)", code, errorMessage); } - throw new LimboException(msg, code); + return new LimboException(msg, code); } - private static String utf8ByteBufferToString(byte[] buffer) { + @Nullable + private static String utf8ByteBufferToString(@Nullable byte[] buffer) { if (buffer == null) { return null; } @@ -143,7 +151,8 @@ public final class LimboDB extends AbstractDB { return new String(buffer, StandardCharsets.UTF_8); } - private static byte[] stringToUtf8ByteArray(String str) { + @Nullable + private static byte[] stringToUtf8ByteArray(@Nullable String str) { if (str == null) { return null; } diff --git a/bindings/java/src/main/java/org/github/tursodatabase/jdbc4/JDBC4Connection.java b/bindings/java/src/main/java/org/github/tursodatabase/jdbc4/JDBC4Connection.java index 04c83b6b9..6ffb41e3e 100644 --- a/bindings/java/src/main/java/org/github/tursodatabase/jdbc4/JDBC4Connection.java +++ b/bindings/java/src/main/java/org/github/tursodatabase/jdbc4/JDBC4Connection.java @@ -1,6 +1,7 @@ package org.github.tursodatabase.jdbc4; import org.github.tursodatabase.LimboConnection; +import org.github.tursodatabase.annotations.SkipNullableCheck; import java.sql.*; import java.util.Map; @@ -14,24 +15,28 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public Statement createStatement() throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public PreparedStatement prepareStatement(String sql) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public CallableStatement prepareCall(String sql) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public String nativeSQL(String sql) throws SQLException { // TODO return ""; @@ -70,6 +75,7 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public DatabaseMetaData getMetaData() throws SQLException { // TODO return null; @@ -109,6 +115,7 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public SQLWarning getWarnings() throws SQLException { // TODO return null; @@ -120,18 +127,21 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency) throws SQLException { // TODO return null; @@ -159,12 +169,14 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public Savepoint setSavepoint() throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public Savepoint setSavepoint(String name) throws SQLException { // TODO return null; @@ -181,60 +193,70 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public Statement createStatement(int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public PreparedStatement prepareStatement(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public CallableStatement prepareCall(String sql, int resultSetType, int resultSetConcurrency, int resultSetHoldability) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public PreparedStatement prepareStatement(String sql, int autoGeneratedKeys) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public PreparedStatement prepareStatement(String sql, int[] columnIndexes) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public PreparedStatement prepareStatement(String sql, String[] columnNames) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public Clob createClob() throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public Blob createBlob() throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public NClob createNClob() throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public SQLXML createSQLXML() throws SQLException { // TODO return null; @@ -263,18 +285,21 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public Properties getClientInfo() throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public Array createArrayOf(String typeName, Object[] elements) throws SQLException { // TODO return null; } @Override + @SkipNullableCheck public Struct createStruct(String typeName, Object[] attributes) throws SQLException { // TODO return null; @@ -286,6 +311,7 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public String getSchema() throws SQLException { // TODO return ""; @@ -308,8 +334,8 @@ public class JDBC4Connection extends LimboConnection { } @Override + @SkipNullableCheck public T unwrap(Class iface) throws SQLException { - // TODO return null; }