/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
module com { module sun { module star { module java {
/** must be implemented by the user of the XJavaVM.
@deprecated
A UNO interface seems to be at the wrong abstraction level for this
functionality (also, the C++ classes jvmaccess::VirtualMachine
and jvmaccess::UnoVirtualMachine
used by
com::sun::star::java::XJavaVM::getJavaVM() are not
part of the public C++ UNO runtime API). This should probably be replaced
by an appropriate C/C++ API.
*/
published interface XJavaVM: com::sun::star::uno::XInterface
{
/** returns the address of the Java Virtual Machine.
If the VM is not already instantiated, it will be now.
If the processID
is a normal 16-byte ID, the returned
`any` contains a JNI JavaVM
pointer as a
`long` or `hyper` integer (depending on the
platform). If the processID
does not match the current
process, or if the VM cannot be instantiated for whatever reason, a
`VOID` `any` is returned.
If the processID
has an additional 17th byte of
value 0
, the returned `any` contains a
non–reference-counted pointer to a (reference-counted) instance of
the C++ jvmaccess::VirtualMachine
class, always represented
as a `hyper` integer. The pointer is guaranteed to be valid
as long as the reference to this
com::sun::star::java::XJavaVM is valid (but the
pointer should be converted into a reference-counted reference as soon
as possible). Again, if the first 16 bytes of the
processID
do not match the current process, or if the VM
cannot be instantiated for whatever reason, a `VOID` `any`
is returned.
If the processID
has an additional 17th byte of
value 1
, the returned `any` contains a
non–reference-counted pointer to a (reference-counted) instance of
the C++ jvmaccess::UnoVirtualMachine
class, always
represented as a `hyper` integer. The pointer is guaranteed
to be valid as long as the reference to this
com::sun::star::java::XJavaVM is valid. Again, if
the first 16 bytes of the processID
do not match the
current process, or if the VM cannot be instantiated for whatever
reason, a `VOID` `any` is returned.
The first form (returning a JNI JavaVM
pointer) is
mainly for backwards compatibility, new code should use the second form
(returning a pointer to a jvmaccess::VirtualMachine
) if it
does not want to use the Java UNO environment, and it should use the
third form (returning a pointer to a
jvmaccess::UnoVirtualMachine
) if it wants to use the Java
UNO environment. For example, one advantage of using
jvmaccess::VirtualMachine
instead of the raw
JavaVM
pointer is that whenever you attach a native thread
to the Java virtual machine, that thread's context
ClassLoader
(see
java.lang.Thread.getContextClassLoader
) will automatically
be set to a meaningful value.
0
or 1
.
@return
On success, the `any` contains a pointer represented as
`long` or `hyper`, otherwise the `any`
is `VOID`.
*/
any getJavaVM( [in] sequenceIt is only possible to get the VM, if this method return 0.
*/ boolean isVMEnabled(); }; }; }; }; }; /* vim:set shiftwidth=4 softtabstop=4 expandtab: */