Class Java

The main java class. This should only be created once per process. Any other attempts to create a new jvm instance will fail.

Index

Constructors

constructor

new Java(
    libPath: string | null | undefined,
    version: string | null | undefined,
    opts: string[] | null | undefined,
    javaOptions: JavaOptions | null | undefined,
    javaLibPath: string,
    nativeLibPath: string,
): Java
Create a new JVM instance.
Parameters
- libPath: string | null | undefined
  The path to jvm.(dll|so|dylib)
- version: string | null | undefined
  The JVM version to use
- opts: string[] | null | undefined
  The JVM options to use
- javaOptions: JavaOptions | null | undefined
  additional options to pass to the jvm
- javaLibPath: string
  the path to the java library (JavaBridge.jar)
- nativeLibPath: string
  the path to the native library (java.*.[dll|so|dylib])
Returns Java
- Defined in native.d.ts:152

Accessors

classLoader

get classLoader(): object
Returns object
- Defined in native.d.ts:191
set classLoader(classLoader: object): void
Parameters
- classLoader: object
Returns void
- Defined in native.d.ts:192

loadedJars

get loadedJars(): string[]
Get the loaded jars.

Returns string[]
- Defined in native.d.ts:183

version

get version(): string
Get the actual JVM version. This may not match the wanted JVM version.

Returns string
- Defined in native.d.ts:181

wantedVersion

get wantedVersion(): string
Get the wanted JVM version. This may not match the actual JVM version.

Returns string
- Defined in native.d.ts:176

Methods

appendClasspath

appendClasspath(classpath: string | string[]): void
Append a single or multiple jars to the classpath.
Parameters
- classpath: string | string[]
Returns void
- Defined in native.d.ts:185

createInterfaceProxy

createInterfaceProxy(
    classname: string,
    methods: Record<
        string,
        (
            err: null | Error,
            callback: (err: Error | null, data?: any | null) => void,
            ...args: any[],
        ) => void,
    >,
    options?: internal.InterfaceProxyOptions | null,
): internal.JavaInterfaceProxy
Parameters
- classname: string
- methods: Record<
      string,
      (
          err: null | Error,
          callback: (err: Error | null, data?: any | null) => void,
          ...args: any[],
      ) => void,
  >
- Optionaloptions: internal.InterfaceProxyOptions | null
Returns internal.JavaInterfaceProxy
- Defined in native.d.ts:188

delete

delete(obj: object): void
Parameters
- obj: object
Returns void
- Defined in native.d.ts:193

importClass

importClass(className: string, config?: ClassConfiguration | null): object
Import a java class Will import the class and parse all of its methods and fields. The imported class will be cached for future use.
Parameters
- className: string
- Optionalconfig: ClassConfiguration | null
Returns object
- Defined in native.d.ts:158

importClassAsync

importClassAsync(
className: string,
config?: ClassConfiguration | null,
): Promise<object>
Import a java class (async) Will return a promise that resolves to the class instance.

If the underlying Java throwable should be contained in the error object, set asyncJavaExceptionObjects to true. This will cause the JavaScript stack trace to be lost. Setting this option in the global config will not affect this method, this option has to be set each time this method is called.
Parameters
- className: string
- Optionalconfig: ClassConfiguration | null
Returns Promise<object>
See
importClass
- Defined in native.d.ts:171

isInstanceOf

isInstanceOf(thisObj: object, other: string | object): boolean
Check if this is instance of other
Parameters
- thisObj: object
- other: string | object
Returns boolean
- Defined in native.d.ts:190

setStdoutCallbacks

setStdoutCallbacks(
stdoutCallback?: ((err: Error | null, data?: string) => void) | null,
stderrCallback?: ((err: Error | null, data?: string) => void) | null,
): StdoutRedirect
Set the stdout/stderr callbacks
Parameters
- OptionalstdoutCallback: ((err: Error | null, data?: string) => void) | null
- OptionalstderrCallback: ((err: Error | null, data?: string) => void) | null
Returns StdoutRedirect
- Defined in native.d.ts:187

Class Java

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Java

Accessors

classLoader

Returns object

Parameters

Returns void

loadedJars

Returns string[]

version

Returns string

wantedVersion

Returns string

Methods

appendClasspath

Parameters

Returns void

createInterfaceProxy

Parameters

Returns internal.JavaInterfaceProxy

delete

Parameters

Returns void

importClass

Parameters

Returns object

importClassAsync

Parameters

Returns Promise<object>

See

isInstanceOf

Parameters

Returns boolean

setStdoutCallbacks

Parameters

Returns StdoutRedirect

Settings

On This Page