dotnet add package IKVM --version 8.7.3
NuGet\Install-Package IKVM -Version 8.7.3
<PackageReference Include="IKVM" Version="8.7.3" />
paket add IKVM --version 8.7.3
#r "nuget: IKVM, 8.7.3"
// Install IKVM as a Cake Addin #addin nuget:?package=IKVM&version=8.7.3 // Install IKVM as a Cake Tool #tool nuget:?package=IKVM&version=8.7.3
IKVM - Java Virtual Machine for .NET
What is IKVM?
IKVM is an implementation of Java for the Microsoft .NET platform. It can be used to quickly and easily:
- Execute compiled Java code (bytecode) on .NET Framework or .NET Core
- Convert bytecode to a .NET assembly to directly access its API in a .NET project
These tasks can be done without porting source code to .NET.
- A Java virtual machine (JVM) implemented in .NET
- A .NET implementation of the Java class libraries
- A tool that translates Java bytecode (JAR files) to .NET IL (DLL or EXE files).
- Tools that enable Java and .NET interoperability
- A full JRE/JDK 8 runtime image.
Run Java Applications with .NET
- Statically: By compiling a Java application into a .NET assembly using
- Libary assemblies can be referenced by any .NET application with a compatible target framework and platform. Types can be referenced by using the Java package name like a .NET namespace.
- Executable assemblies can be launched by specifying the class containing the
main()method to execute at runtime when building using
- Dynamically: By running a Java application using the
javaexecutable inside of the JDK Runtime Image. The Java bytecode is converted on-the-fly to CIL and executed. The experience should be identical to a normal JDK.
What IKVM is Not
- A converter utility to transform Java source code to C# source code
- A decompiler utitity to transform compiled Java bytecode to C# source code
- A tool that runs .NET code in Java - all IKVM conversions are Java > .NET
- .NET Framework 4.7.2 and higher (SDK-style projects)
- .NET 6 and higher
- Java SE 8
- Windows x86/x64/ARM/ARM64
- Linux x64/ARM/ARM64 (GLIBC and MUSL)
- Mac OS X x64/arm64
Various differences exist between support for all of our different artifacts. For instance, there are some platforms we cannot distribute images for and some platforms we cannot distribute tools for.
PM> Install-Package IKVM
Or, to use
PM> Install-Package IKVM.Maven.Sdk
The tools are available for download on the Releases page.
Both a JRE and JDK runtime image are available. These images are standard JRE or JDK directory structures containing all of the standard tools: javac, jdeps, policytool, keytool, etc. Some Java libraries may require either a JRE or JDK, and if so, the
IKVM.Image.JDK package should be added to your project.
PM> Install-Package IKVM.Image.JRE PM> Install-Package IKVM.Image.JDK
A standalone JDK distributable is available for download on the Releases page. This directory structure should suffice as a
JAVA_HOME path for standard Java applications.
IKVM supports integration with .NET SDK-style projects as well as low level tools for running compiled Java code directly or for advanced build scenarios. The 2 main entry points for integration with the .NET SDK-style projects are
MavenReference. .NET SDK-style projects can be built on the command line directly or using an IDE that supports them, such as recent versions Visual Studio or JetBrains Rider.
IKVM includes build-time support for translating Java libraries to .NET assemblies. Install the
IKVM package in a project that requires references to Java libraries. Use
IkvmReference within an
ItemGroup to indicate which Java libraries your project requires.
<ItemGroup> <PackageReference Include="IKVM" Version="Version" /> </ItemGroup> <ItemGroup> <IkvmReference Include="..\..\ext\helloworld\helloworld-2.0.jar" /> </ItemGroup>
The output assembly will be generated as part of your project's build process and a reference will automatically be added to your project so you can call APIs of the compiled
.jar assembly. Additional metadata can be added to
IkvmReference to customize the assembly that is generated.
<ItemGroup> <IkvmReference Include="..\..\ext\helloworld\helloworld-2.0.jar"> <AssemblyName>MyAssembly</AssemblyName> <AssemblyVersion>220.127.116.11</AssemblyVersion> <AssemblyFileVersion>18.104.22.168</AssemblyFileVersion> <DisableAutoAssemblyName>true</DisableAutoAssemblyName> <DisableAutoAssemblyVersion>true</DisableAutoAssemblyVersion> <FallbackAssemblyName>MyAssemblyFallback</FallbackAssemblyName> <FallbackAssemblyVersion>22.214.171.124</FallbackAssemblyVersion> <KeyFile>MyKey.snk</KeyFile> <DelaySign>true</DelaySign> <Compile>SomeInternalDependency.jar;SomeOtherInternalDependency.jar</Compile> <Sources>MyClass.java;YourClass.java</Sources> <References>SomeExternalDependency.jar;SomeOtherExternalDependency.jar</References> <Aliases>MyAssemblyAlias;helloworld2_0</Aliases> <Debug>true</Debug> </IkvmReference> </ItemGroup>
Attributes and Elements
The following values can be used as either an attribute or a nested element of
|Attribute or Element||Description|
||The identity of the
||By default the
||By default the
||By default the
||Specifies the filename containing the cryptographic key. When this option is used, the compiler inserts the public key from the specified file into the assembly manifest and then signs the final assembly with the private key.|
||This option causes the compiler to reserve space in the output file so that a digital signature can be added later. Use
||A semi-colon separated list of Java class path items to compile into the assembly. By default this value is the
||A semi-colon separated list of Java source files to use during documentation generation. (not yet supported)|
||Optional semi-colon separated list of other
||Optional boolean indicating whether to generate debug symbols. By default this is determined based on the
||A semi-colon separated list of aliases that can be used to reference the assembly in
|All other metadata supported on the
IkvmReference is not transitive. Including it in one project and adding a dependency to that project from a second
project will not result in the same reference being available on the second project. Instead, add the reference to
For each project to resolve to the same resulting assembly ensure their settings are identical.
IkvmReference entries can be configured to include each other as references.
<ItemGroup> <IkvmReference Include="helloworld.jar"> <AssemblyVersion>126.96.36.199</AssemblyVersion> </IkvmReference> <IkvmReference Include="helloworld-2.jar"> <AssemblyName>helloworld-2</AssemblyName> <AssemblyVersion>188.8.131.52</AssemblyVersion> <References>helloworld.jar</References> <Aliases>helloworld2</Aliases> </IkvmReference> </ItemGroup>
Automatic-Module-Name is either a specified attribute of the JAR manifest, which can be found in the
META-INF/MANIFEST.MF file inside the JAR, or a generated value based on the name of the JAR file. See the documentation for more information.
See the ikvm-maven Readme for usage instructions.
Notice To Project Owners
The IKVM project recommends that people do not redistribute FOSS Java libraries compiled with IKVM over public systems such as NuGet.org, unless you are the original owner of that software and have a compelling reason.
Creating copies of FOSS Java libraries and publishing them to distribution mechanisms such as NuGet.org creates eco-system confusion and dependency conflicts downstream. We provide a system so that .NET users of Java libraries can reference those libraries directly out of the standard Java ecosystem mechanisms: Maven Central, etc though IKVM.Maven. Remember, very few libraries exist in a vacuum. Libraries often depend on dozens of other libraries. Two unrelated Java libraries often depend on the same underlying Java library. A complex method of dependency conflict resolution and version unification has to be involved in resolving this hierarchy for any individual downstream project. You are likely going to be introducing duplicate classes into the users of your versions, or causing your users to depend upon the wrong version of other libraries.
In addition to the above, we presently do not guarentee that API between statically compiled assemblies and the IKVM.Java and IKVM.Runtime libraries remains stable. A statically compiled assembly built against one version of IKVM is not guarenteed to run against a higher version of IKVM, even at the patch level. We would like to advertise better support for this in the future, but at present there is a lot of work planned for the IKVM.Runtime and IKVM.Java APIs that we don't want to inhibit. Since we also provide build tools to make the process of recompiling assemblies from the build machine easy, if recommendations are followed, this should be of limited impact.
There are exceptions to this advice, such as the library not being published to Maven. In that case, guidance would be to advocate that the original Java library in fact be published to Maven, or do the work yourself, as that is the appropriate place for Java libraries.
We cannot force you to conform to this advice. But for the health of the ecosystem, we urge you to take it under consideration yourself.
|Product||Versions Compatible and additional computed target framework versions.|
|.NET||net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.|
|.NET Framework||net472 is compatible. net48 was computed. net481 was computed.|
- IKVM.Image (>= 8.7.3)
- IKVM.MSBuild (>= 8.7.3)
- Mono.Posix (>= 7.1.0-final.1.21458.1)
- Mono.Unix (>= 7.1.0-final.1.21458.1)
- System.Buffers (>= 4.5.1)
- System.IO.Pipelines (>= 6.0.3)
- System.Memory (>= 4.5.5)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
- System.Runtime.InteropServices.RuntimeInformation (>= 4.3.0)
- System.Text.Json (>= 6.0.6)
- System.ValueTuple (>= 4.5.0)
NuGet packages (88)
Showing the top 5 NuGet packages that depend on IKVM:
Bare-bones IKVM Java-to-.NET port of Apache Tika. You'll want to install TikaOnDotNet.TextExtractor.
Stanford CoreNLP provides a set of natural language analysis tools which can take raw English language text input and give the base forms of words, their parts of speech, whether they are names of companies, people, etc., normalize dates, times, and numeric quantities, and mark up the structure of sentences in terms of phrases and word dependencies, and indicate which noun phrases refer to the same entities. Stanford CoreNLP is an integrated framework, which make it very easy to apply a bunch of language analysis tools to a piece of text. Starting from plain text, you can run all the tools on it with just two lines of code. Its analyses provide the foundational building blocks for higher-level and domain-specific text understanding applications.
Curator client library & recipes for Zookeeper. This is the IKVM version; which is to say that this is compiled from Java to .NET
Stanford NER (also known as CRFClassifier) is a Java implementation of a Named Entity Recognizer. Named Entity Recognition (NER) labels sequences of words in a text which are the names of things, such as person and company names, or gene and protein names. The software provides a general (arbitrary order) implementation of linear chain Conditional Random Field (CRF) sequence models, coupled with well-engineered feature extractors for Named Entity Recognition.
The Apache OpenNLP library is a machine learning based toolkit for the processing of natural language text. It supports the most common NLP tasks, such as tokenization, sentence segmentation, part-of-speech tagging, named entity extraction, chunking, parsing, and coreference resolution. These tasks are usually required to build more advanced text processing services. OpenNLP also included maximum entropy and perceptron based machine learning.
GitHub repositories (4)
Showing the top 4 popular GitHub repositories that depend on IKVM:
A Java Virtual Machine and Bytecode-to-IL Converter for .NET
Search tool to find specific files containing specific words, i.e. files containing passwords..
Java to C# converter
Search for and download comics that are added to GetComics.info easily