|
UDK 3.2.7 Java API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.star.uno.UnoRuntime
public class UnoRuntime
The central class needed for implementing or using UNO components in Java.
The methods queryInterface
and areSame
delegate
calls to the implementing objects and are used instead of casts,
instanceof
, ==
, and equals
.
For historic reasons, this class is not final
, and has a
public
constructor. These artifacts are considered mistakes,
which might be corrected in a future version of this class, so client code
should not rely on them.
IBridge
,
IEnvironment
,
IQueryInterface
Field Summary | |
---|---|
static boolean |
DEBUG
Deprecated. As of UDK 3.2.0, do not use this internal field. |
Constructor Summary | |
---|---|
UnoRuntime()
Deprecated. As of UDK 3.2.0, do not create instances of this class. It is considered a historic mistake to have a public
constructor for this class, which only has static members.
Also, this class might be changed to become final in a
future version. |
Method Summary | ||
---|---|---|
static boolean |
areSame(Object any1,
Object any2)
Tests two UNO ANY values for equality. |
|
static Object |
completeValue(Type type,
Object value)
Complete a UNO value (make sure it is no invalid null
value). |
|
static String |
generateOid(Object object)
Generates a world wide unique object identifier (OID) for the given Java object. |
|
static IBridge |
getBridge(IEnvironment from,
IEnvironment to,
Object[] args)
Deprecated. As of UDK 3.2.0, this method is deprecated, without offering a replacement. |
|
static IBridge |
getBridgeByName(String from,
Object fromContext,
String to,
Object toContext,
Object[] args)
Deprecated. As of UDK 3.2.0, this method is deprecated, without offering a replacement. |
|
static IBridge[] |
getBridges()
Deprecated. As of UDK 3.2.0, this method is deprecated, without offering a replacement. |
|
static XCurrentContext |
getCurrentContext()
Gets the current context of the current thread, or null if
no context has been set for the current thread. |
|
static IEnvironment |
getEnvironment(String name,
Object context)
Deprecated. As of UDK 3.2.0, this method is deprecated, without offering a replacement. |
|
static IMapping |
getMapping(IEnvironment from,
IEnvironment to)
Deprecated. As of UDK 3.2.0, this method is deprecated, without offering a replacement. |
|
static IMapping |
getMappingByName(String from,
String to)
Deprecated. As of UDK 3.2.0, this method is deprecated, without offering a replacement. |
|
static String |
getUniqueKey()
Generates a world wide unique identifier string. |
|
static
|
queryInterface(Class<T> zInterface,
Object object)
Queries the given UNO object for the given Java class (which must represent a UNO interface type). |
|
static Object |
queryInterface(Type type,
Object object)
Queries the given UNO object for the given UNO interface type. |
|
static boolean |
reset()
Deprecated. As of UDK 3.2.0, this method is deprecated, without offering a replacement. |
|
static void |
setCurrentContext(XCurrentContext context)
Sets the current context for the current thread. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final boolean DEBUG
Constructor Detail |
---|
public UnoRuntime()
public
constructor for this class, which only has static
members.
Also, this class might be changed to become final
in a
future version.
Method Detail |
---|
public static String getUniqueKey()
It is guaranteed that every invocation of this method generates a new ID, which is unique within the VM. The quality of “world wide unique” will depend on the actual implementation, you should look at the source to determine if it meets your requirements.
String
public static String generateOid(Object object)
It is guaranteed that subsequent calls to this method with the same Java object will give the same ID.
This method is generally of little use for client code. It should be considered a mistake that this method is published at all.
object
- any object for which a OID shall be generated; must not be
null
IQueryInterface.getOid()
public static Object queryInterface(Type type, Object object)
This method returns null
in case the given UNO object
does not support the given UNO interface type (or is itself
null
). Otherwise, a reference to a Java object implementing
the Java interface type corresponding to the given UNO interface is
returned. In the latter case, it is unspecified whether the returned
Java object is the same as the given object, or is another facet of that
UNO object.
type
- the requested UNO interface type; must be a Type
object representing a UNO interface typeobject
- a reference to any Java object representing (a facet of) a
UNO object; may be null
null
IQueryInterface.queryInterface(com.sun.star.uno.Type)
public static <T> T queryInterface(Class<T> zInterface, Object object)
ifc
- a Java class representing a UNO interface typeobject
- a reference to any Java object representing (a facet of) a
UNO object; may be null
null
queryInterface(Type, Object)
public static boolean areSame(Object any1, Object any2)
ANY
values for equality.
Two UNO values are equal if and only if they are of the same UNO type t, and they meet the following condition, depending on t:
any1
- a Java value representing a UNO ANY
value.any2
- a Java value representing a UNO ANY
value.
true
if and only if the two arguments represent
equal UNO values.public static final Object completeValue(Type type, Object value)
null
value).
This is useful for members of parameterized type of instantiated
polymorphic struct types, as null
is a valid value there
(and only there, for all types except ANY
and interface
types).
type
- a non-void, non-exception UNO type.value
- a Java value representing a UNO value of the given UNO type,
or null
.
null
value.public static XCurrentContext getCurrentContext()
null
if
no context has been set for the current thread.
The current context is thread local, which means that this method returns the context that was last set for this thread.
null
if no context has been set for the current threadpublic static void setCurrentContext(XCurrentContext context)
The current context is thread local. To support a stacking behaviour,
every function that sets the current context should reset it to the
original value when exiting (for example, within a finally
block).
context
- the context to be set; if null
, any
previously set context will be removedpublic static IEnvironment getEnvironment(String name, Object context) throws Exception
name
with context
context
.
Environments are held weakly by this class. If the requested
environment already exists, this methods simply returns it. Otherwise,
this method looks for it under
com.sun.star.lib.uno.environments.name.name_environment
.
name
- the name of the environmentcontext
- the context of the environment
Exception
IEnvironment
public static IBridge getBridge(IEnvironment from, IEnvironment to, Object[] args) throws Exception
from
to environment
to
.
Creates a new bridge, if the requested bridge does not yet exist, and hands the arguments to the bridge.
If the requested bridge does not exist, it is searched for in package
com.sun.star.lib.uno.bridges.from_to;
and the root classpath as
from_to_bridge
.
from
- the source environmentto
- the target environmentargs
- the initial arguments for the bridge
Exception
getBridgeByName(java.lang.String, java.lang.Object, java.lang.String, java.lang.Object, java.lang.Object[])
,
IBridge
,
IEnvironment
public static IBridge getBridgeByName(String from, Object fromContext, String to, Object toContext, Object[] args) throws Exception
from
to environment
to
.
Creates a new bridge, if the requested bridge does not yet exist, and hands the arguments to the bridge.
If the requested bridge does not exist, it is searched for in package
com.sun.star.lib.uno.bridges.from_to;
and the root classpath as
from_to_bridge
. The used environments
are retrieved through getEnvironment
.
from
- the name of the source environmentfromContext
- the context for the source environmentto
- the name of the target environmenttoContext
- the context for the target environmentargs
- the initial arguments for the bridge
Exception
getBridge(com.sun.star.uno.IEnvironment, com.sun.star.uno.IEnvironment, java.lang.Object[])
,
getEnvironment(java.lang.String, java.lang.Object)
,
IBridge
,
IEnvironment
public static IBridge[] getBridges()
IBridge
objectsIBridge
public static IMapping getMapping(IEnvironment from, IEnvironment to) throws Exception
from
to environment
to
.
Mappings are like bridges, except that with mappings one can only map in one direction. Mappings are here for compatibility with the binary UNO API. Mappings are implemented as wrappers around bridges.
from
- the source environmentto
- the target environment
Exception
IEnvironment
,
IMapping
public static IMapping getMappingByName(String from, String to) throws Exception
from
to environment
to
.
The used environments are retrieved through
getEnvironment
.
from
- the name of the source environmentto
- the name of the target environment
Exception
getEnvironment(java.lang.String, java.lang.Object)
,
getMapping(com.sun.star.uno.IEnvironment, com.sun.star.uno.IEnvironment)
,
IMapping
public static boolean reset()
UnoRuntime
to its initial state.
Releases all references to bridges and environments.
|
UDK 3.2.7 Java API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |