Update on SwiftJavaDocumentation #372
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ktoso
reviewed
Aug 22, 2025
| ### JExtract: Java -> Swift | ||
|
|
||
| SwiftJava's `swift-java jextract` tool automates generating Java bindings from Swift sources. | ||
| SwiftJava's `swift-java jextract` tool automates generating Java bindings to Swift sources. |
Collaborator
There was a problem hiding this comment.
This is "from"; we take swift sources as input and generate java; so it's not that the bindings are 'to' swift but that we generate them "from swift sources" 🤔
Maybe this whole sentence needs rewording?
Contributor
Author
There was a problem hiding this comment.
Ah, ok, I was trying to align with the README line 34
**swift-java jextract**
Is a source generator which will **generate Java bindings to existing Swift libraries**.
How about changing the README to "from" for now, and rewording them both afterwards
Contributor
Author
There was a problem hiding this comment.
I went through the subcommand help message. If I am not mistaken, it should be:
wrap-java: Generates Swift bindings from Java code (Java → Swift).
jextract: Generates Java bindings from Swift code (Swift → Java).
ktoso
reviewed
Aug 22, 2025
| TODO: Some general intro | ||
|
|
||
| If you prefer a video introduction, you may want to this | ||
| **SwiftJava** provides Java and Swift interoperability with minimal overhead. It eliminates the complex, error-prone process such as manually compiling Java classes to C headers for native access. With SwiftJava, developers can achieve a flexible, safe, and high-performance connection between the two languages. |
Collaborator
There was a problem hiding this comment.
This comes of a bit weird, no-one is manually compiling java classes in either approach. Maybe something like
Suggested change
| **SwiftJava** provides Java and Swift interoperability with minimal overhead. It eliminates the complex, error-prone process such as manually compiling Java classes to C headers for native access. With SwiftJava, developers can achieve a flexible, safe, and high-performance connection between the two languages. | |
| **SwiftJava** provides a set of tools and libraries to enable Java and Swift interoperability. It allows developers to generate bindings to either language from the other, by using either source generation (for Java consuming Swift code), or by using a combination of Swift macros and source generation (for Swift consuming Java libraries). | |
| The generated code is highly efficient, and less error-prone than manually writing the mappings by hand, and also guarantees memory safety across the boundaries between the languages. |
ktoso
reviewed
Aug 22, 2025
| If you prefer a video introduction, you may want to this | ||
| **SwiftJava** provides Java and Swift interoperability with minimal overhead. It eliminates the complex, error-prone process such as manually compiling Java classes to C headers for native access. With SwiftJava, developers can achieve a flexible, safe, and high-performance connection between the two languages. | ||
|
|
||
| **Interoperability promotes** |
Collaborator
There was a problem hiding this comment.
Suggested change
| **Interoperability promotes** | |
| Reasons why you might want to reach for Swift and Java interoperability include, but are not limited to, the following scenarios: |
ktoso
reviewed
Aug 22, 2025
| **SwiftJava** provides Java and Swift interoperability with minimal overhead. It eliminates the complex, error-prone process such as manually compiling Java classes to C headers for native access. With SwiftJava, developers can achieve a flexible, safe, and high-performance connection between the two languages. | ||
|
|
||
| **Interoperability promotes** | ||
| - Incremental adoption of Swift |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Incremental adoption of Swift | |
| - Incremental adoption of Swift, in an existing Java codebase |
ktoso
reviewed
Aug 22, 2025
| **Interoperability promotes** | ||
| - Incremental adoption of Swift | ||
| - Reuse of libraries across languages | ||
| - Access libraries with or without native APIs |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Access libraries with or without native APIs | |
| - Reuse existing libraries which exist in one ecosystem, but don't have a direct equivalent in the other |
ktoso
reviewed
Aug 22, 2025
| - Reuse of libraries across languages | ||
| - Access libraries with or without native APIs | ||
| - Implement performance-sensitive code in Swift | ||
| - Support for ecosystem-specific build tools |
Collaborator
There was a problem hiding this comment.
I'd drop this, as we're just listing why you might want to use this project now
Suggested change
| - Support for ecosystem-specific build tools |
ktoso
reviewed
Aug 22, 2025
| - Implement performance-sensitive code in Swift | ||
| - Support for ecosystem-specific build tools | ||
|
|
||
| **Tools** |
Collaborator
There was a problem hiding this comment.
Suggested change
| **Tools** | |
| SwiftJava is offering a number of core libraries which support the language interoperability: |
ktoso
reviewed
Aug 22, 2025
|
|
||
| **Tools** | ||
| - Swift Package: | ||
| - JavaKit (Java -> Swift) |
Collaborator
There was a problem hiding this comment.
Suggested change
| - JavaKit (Java -> Swift) | |
| - JavaKit (Swift -> Java) - JNI based support library and Swift macros |
ktoso
reviewed
Aug 22, 2025
| - Swift Package: | ||
| - JavaKit (Java -> Swift) | ||
| - Java Library: | ||
| - SwiftKit (Swift -> Java) |
Collaborator
There was a problem hiding this comment.
Suggested change
| - SwiftKit (Swift -> Java) | |
| - SwiftKit (Java -> Swift) - Suport library for Java calling Swift code (either using JNI or FFM) |
ktoso
reviewed
Aug 22, 2025
| - Java Library: | ||
| - SwiftKit (Swift -> Java) | ||
| - Tooling: | ||
| - swift-java: command line tool |
Collaborator
There was a problem hiding this comment.
Suggested change
| - swift-java: command line tool | |
| - `swift-java` - command line tool; Supports source generation and also dependency management operations |
ktoso
reviewed
Aug 22, 2025
| - SwiftKit (Swift -> Java) | ||
| - Tooling: | ||
| - swift-java: command line tool | ||
| - Build tool integration: SwiftPM Plugin or Gradle |
Collaborator
There was a problem hiding this comment.
Suggested change
| - Build tool integration: SwiftPM Plugin or Gradle | |
| - Build tool integration: SwiftPM Plugin |
we don't yet have a gradle plugin
ktoso
reviewed
Aug 22, 2025
Collaborator
ktoso
left a comment
ktoso
left a comment
There was a problem hiding this comment.
Left a bunch of notes to make it flow a bit better. Please have a look; thanks for the effort updating our docs!
Contributor
Author
|
Thank you very much for the feedback! I will update it accordingly |
Corrected the direction of interoperability in the documentation and updated the status of Java features.
ktoso
reviewed
Aug 25, 2025
Sources/SwiftJavaDocumentation/Documentation.docc/SupportedFeatures.md
Outdated
Show resolved
Hide resolved
ktoso
approved these changes
Aug 25, 2025
Collaborator
|
Thanks :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
SupportedFeatures.mdJExtract Java -> Swift section