Skip to content

Commit 899dc23

Browse files
authored
Update README and SupportedFeatures (swiftlang#383)
* update gitgnore * align with README JExtract from Java to Swift * add watch to 'you may want to this' * add intro to SwiftJavaDocumentation index.md * add intro to SwiftJavaDocumentation index.md * add intro to SwiftJavaDocumentation index.md * align documentation with module rename * SwiftJavaDocumentation correction * Revert "SwiftJavaDocumentation correction" This reverts commit f65061c. * revert ConfigureCommand formatting * revert SupportFeatures.md * update benchmark sample project name * renaming JavaKit to SwiftJava * renaming JavaKit to SwiftJava in SupportedFeatures
1 parent 67c8153 commit 899dc23

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This repository contains two approaches to Swift/Java interoperability.
44

5-
- Swift library (`JavaKit`) and bindings generator that allows a Swift program to make use of Java libraries by wrapping Java classes in corresponding Swift types, allowing Swift to directly call any wrapped Java API.
5+
- Swift library (`SwiftJava`) and bindings generator that allows a Swift program to make use of Java libraries by wrapping Java classes in corresponding Swift types, allowing Swift to directly call any wrapped Java API.
66
- The `swift-java` tool which which offers automated ways to import or "extract" bindings to sources or libraries in either language. The results are bindings for Swift or Java.
77

88
## :construction: :construction: :construction: Early Development :construction: :construction: :construction:
@@ -19,11 +19,11 @@ The primary purpose of this repository is to create an environment for collabora
1919

2020
This project consists of different modules which have different Swift and Java runtime requirements.
2121

22-
## JavaKit macros
22+
## SwiftJava macros
2323

24-
JavaKit is a Swift library offering macros which simplify writing JNI code "by hand" but also calling Java code from Swift.
24+
SwiftJava is a Swift library offering macros which simplify writing JNI code "by hand" but also calling Java code from Swift.
2525

26-
It is possible to generate Swift bindings to Java libraries using JavaKit by using the `swift-java wrap-java` command.
26+
It is possible to generate Swift bindings to Java libraries using SwiftJava by using the `swift-java wrap-java` command.
2727

2828
Required language/runtime versions:
2929
- **JDK 17+**, any recent JDK installation should be sufficient, as only general reflection and JNI APIs are used by this integration
@@ -124,12 +124,12 @@ Please always use the gradle wrapper (`./gradlew`) to make sure to use the appro
124124
125125
Sample apps are located in the `Samples/` directory, and they showcase full "roundtrip" usage of the library and/or tools.
126126
127-
#### JavaKit (Swift -> Java)
127+
#### SwiftJava (Swift -> Java)
128128
129129
To run a simple app showcasing a Swift process calling into a Java library you can run:
130130
131131
```bash
132-
cd Samples/JavaKitSampleApp
132+
cd Samples/SwiftJavaExtractFFMSampleApp
133133
./ci-validate.sh # which is just `swift build` and a `java -cp ...` invocation of the compiled program
134134
```
135135

Sources/SwiftJavaDocumentation/Documentation.docc/SupportedFeatures.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ Summary of features supported by the swift-java interoperability libraries and t
44

55
## Overview
66

7-
JavaKit supports both directions of interoperability, using Swift macros and source generation
7+
SwiftJava supports both directions of interoperability, using Swift macros and source generation
88
(via the `swift-java wrap-java` command).
99

1010
### Java -> Swift
1111

12-
It is possible to use JavaKit macros and the `wrap-java` command to simplify implementing
13-
Java `native` functions. JavaKit simplifies the type conversions
12+
It is possible to use SwiftJava macros and the `wrap-java` command to simplify implementing
13+
Java `native` functions. SwiftJava simplifies the type conversions
1414

1515
> tip: This direction of interoperability is covered in the WWDC2025 session 'Explore Swift and Java interoperability'
1616
> around the [7-minute mark](https://youtu.be/QSHO-GUGidA?si=vUXxphTeO-CHVZ3L&t=448).
@@ -74,8 +74,8 @@ SwiftJava's `swift-java jextract` tool automates generating Java bindings from S
7474
| Optional parameters: `func f(i: Int?, class: MyClass?)` |||
7575
| Optional return types: `func f() -> Int?`, `func g() -> MyClass?` |||
7676
| Primitive types: `Bool`, `Int`, `Int8`, `Int16`, `Int32`, `Int64`, `Float`, `Double` |||
77-
| Parameters: JavaKit wrapped types `JavaLong`, `JavaInteger` |||
78-
| Return values: JavaKit wrapped types `JavaLong`, `JavaInteger` |||
77+
| Parameters: SwiftJava wrapped types `JavaLong`, `JavaInteger` |||
78+
| Return values: SwiftJava wrapped types `JavaLong`, `JavaInteger` |||
7979
| Unsigned primitive types: `UInt`, `UInt8`, `UInt16`, `UInt32`, `UInt64` | ✅ * | ✅ * |
8080
| String (with copying data) |||
8181
| Variadic parameters: `T...` |||

0 commit comments

Comments
 (0)