IKVM 8.2.1

.NET Core 3.1 .NET Framework 4.6.1
There is a newer prerelease version of this package available.
See the version list below for details.
NuGet\Install-Package IKVM -Version 8.2.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
dotnet add package IKVM --version 8.2.1
<PackageReference Include="IKVM" Version="8.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add IKVM --version 8.2.1
#r "nuget: IKVM, 8.2.1"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install IKVM as a Cake Addin
#addin nuget:?package=IKVM&version=8.2.1

// Install IKVM as a Cake Tool
#tool nuget:?package=IKVM&version=8.2.1

IKVM - Java Virtual Machine for .NET

Nuget

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.

IKVM Components

  • 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

Run Java Applications with .NET

  1. Statically: By compiling a Java application into a .NET assembly using <MavenReference>, <IkvmReference> or ikvmc.
    • 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 ikvmc.
  2. Dynamically: By running a Java application using the ikvm tool, which can be used as a direct replacement for java.exe. The Java bytecode is converted on-the-fly to CIL and executed.

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

Support

  • .NET Framework 4.6.1 and higher
  • .NET Core 3.1 and higher
  • .NET 5 and higher
  • Java SE 8

Documentation

See the tutorial to get started or IKVM.NET In Details for a more in-depth look.

Installation

NuGet

PM> Install-Package IKVM

Or, to use MavenReference:

PM> Install-Package IKVM.Maven.Sdk

Tools

The tools are a available for download on the Releases page.

Usage

IKVM supports integration with .NET SDK 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 are IkvmReference and MavenReference. .NET SDK 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.

IkvmReference

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.

Example
<ItemGroup>
  <PackageReference Include="IKVM" Version="8.2.0" />
</ItemGroup>

<ItemGroup>
  <IkvmReference Include="..\..\ext\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.

Syntax
<ItemGroup>
   <IkvmReference Include="..\..\ext\helloworld-2.0.jar">
      <AssemblyName>MyAssembly</AssemblyName>
      <AssemblyVersion>3.2.1.0</AssemblyVersion>
      <AssemblyFileVersion>3.0.0.0</AssemblyFileVersion>
      <DisableAutoAssemblyName>true</DisableAutoAssemblyName>
      <DisableAutoAssemblyVersion>true</DisableAutoAssemblyVersion>
      <FallbackAssemblyName>MyAssemblyFallback</FallbackAssemblyName>
      <FallbackAssemblyVersion>3.1.0.0</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 <IkvmReference>.

Attribute or Element Description
Include (attribute only) The identity of the IkvmReference item. The value can be one of: <ul><li>path to a JAR file</li><li>path to a directory</li><li>an otherwise unimportant name</li></ul>
AssemblyName By default the AssemblyName is generated using the rules defined by the Automatic-Module-Name specification. To override this, do so here. The value should not include a file extension, .dll will be appended automatically.
AssemblyVersion By default the AssemblyVersion is generated using the rules defined by the Automatic-Module-Name specification. To override this, do so here.
AssemblyFileVersion By default the AssemblyFileVersion is generated using the rules defined by the Automatic-Module-Name specification or, if overridden, the same value as AssemblyVersion. To override this, do so here.
DisableAutoAssemblyName If true disables detection of AssemblyName.
DisableAutoAssemblyVersion If true disables detection of AssemblyVersion.
FallbackAssemblyName If AssemblyName is not provided or cannot be calculated, use this value.
FallbackAssemblyVersion If AssemblyVersion is not provided or cannot be calculated, use this value.
KeyFile 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.
DelaySign This option causes the compiler to reserve space in the output file so that a digital signature can be added later. Use DelaySign if you only want to place the public key in the assembly. The DelaySign option has no effect unless used with KeyFile.
Compile A semi-colon separated list of Java class path items to compile into the assembly. By default this value is the Identity of the item, if the identity of the item is an existing JAR file or directory (not yet supported). MSBuild globs are supported to reference multiple JAR or .class files.
Sources A semi-colon separated list of Java source files to use during documentation generation. (not yet supported)
References Optional semi-colon separated list of other IkvmReference identity values to specify as a reference to the current one. For example, if foo.jar depends on bar.jar, include both as IkvmReference items, but specify the identity of bar.jar on the References metadata of foo.jar.
Debug Optional boolean indicating whether to generate debug symbols. By default this is determined based on the <DebugType> and <DebugSymbols> properties of the project. Only full debug symbols are currently supported.
Aliases A semi-colon separated list of aliases that can be used to reference the assembly in References.
All other metadata supported on the Reference MSBuild item group definition.

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 each project.

For each project to resolve to the same resulting assembly ensure their settings are identical.

Multiple IkvmReference entries can be configured to include each other as references.

<ItemGroup>
   <IkvmReference Include="helloworld.jar">
      <AssemblyVersion>1.0.0.0</AssemblyVersion>
   </IkvmReference>
   <IkvmReference Include="helloworld-2.jar">
      <AssemblyName>helloworld-2</AssemblyName>
      <AssemblyVersion>2.0.0.0</AssemblyVersion>
      <References>helloworld.jar</References>
      <Aliases>helloworld2</Aliases>
   </IkvmReference>
</ItemGroup>
Automatic-Module-Name Specification

The 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.

MavenReference

See the ikvm-maven Readme for usage instructions.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp3.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (80)

Showing the top 5 NuGet packages that depend on IKVM:

Package Downloads
TikaOnDotNet

Bare-bones IKVM Java-to-.NET port of Apache Tika. You'll want to install TikaOnDotNet.TextExtractor.

Stanford.NLP.CoreNLP

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.

Stanford.NLP.NER

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.

CuratorIkvm

Curator client library & recipes for Zookeeper. This is the IKVM version; which is to say that this is compiled from Java to .NET

NHtmlUnit

NHtmlUnit is a .NET wrapper of HtmlUnit; a "GUI-less browser for Java programs". It allows you to write code to test web applications with a headless, automated browser.

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on IKVM:

Repository Stars
vivami/SauronEye
Search tool to find specific files containing specific words, i.e. files containing passwords..
ikvm-revived/ikvm
A Java Virtual Machine and Bytecode-to-IL Converter for .NET
paulirwin/JavaToCSharp
Java to C# converter
fireshaper/Omnibus
Search for and download comics that are added to GetComics.info easily
Version Downloads Last updated
8.2.2-prerelease0553 75 9/21/2022
8.2.2-prerelease0396 41 9/20/2022
8.2.2-prerelease0241 103 9/5/2022
8.2.2-prerelease0163 158 8/26/2022
8.2.2-prerelease0106 88 8/26/2022
8.2.2-prerelease0051 101 8/25/2022
8.2.1 28,307 7/25/2022
8.2.0 19,870 7/3/2022
8.2.0-prerelease3420 643 7/2/2022
8.2.0-prerelease2777 750 6/30/2022
8.2.0-prerelease2138 453 6/28/2022
8.2.0-prerelease1515 818 6/24/2022
8.2.0-prerelease0911 1,330 6/16/2022
8.2.0-prerelease0899 3,654 6/15/2022
8.2.0-prerelease0892 181 6/14/2022
8.2.0-prerelease0809 468 6/6/2022
8.2.0-prerelease0392 596 5/29/2022
8.1.5717 2,233,631 8/26/2015
8.0.5449.1 109,878 1/12/2015
8.0.5449 7,280 12/2/2014
7.4.5196 68,399 3/24/2014
7.3.4830 129,761 3/28/2013
7.2.4630.5 140,630 12/10/2012
7.1.4532.2 19,877 9/17/2012
7.0.4335 3,326 12/29/2011
0.46.0.1 31,737 8/24/2011