com.sun.jna.platform.win32.COM.util

Class ProxyObject

java.lang.Object

com.sun.jna.platform.win32.COM.util.ProxyObject

All Implemented Interfaces:

IDispatch, IRawDispatchHandle, IUnknown, InvocationHandler

public class ProxyObject
extends Object
implements InvocationHandler, IDispatch, IRawDispatchHandle

This object acts as the invocation handler for interfaces annotated with ComInterface. It wraps all (necessary) low level COM calls and executes them on a 'ComThread' held by the Factory object.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) ComThread	comThread
(package private) Factory	factory
static WinDef.LCID	LOCALE_SYSTEM_DEFAULT The Constant LOCALE_SYSTEM_DEFAULT.
static WinDef.LCID	LOCALE_USER_DEFAULT The Constant LOCALE_USER_DEFAULT.
(package private) IDispatch	rawDispatch
(package private) Class<?>	theInterface
(package private) long	unknownId

Constructor Summary

Constructors

Constructor and Description
ProxyObject(Class<?> theInterface, IDispatch rawDispatch, Factory factory)
ProxyObject(Class<?> theInterface, long unknownId, IDispatch rawDispatch, Factory factory) when proxy is created for arguments on a call back, they are already on the com thread, and hence calling 'getUnknownId' will not work as it uses the ComThread however, the unknown pointer value is passed in;

Method Summary

Modifier and Type	Method and Description
IComEventCallbackCookie	advise(Class<?> comEventCallbackInterface, IComEventCallbackListener comEventCallbackListener)
void	dispose(int r)
boolean	equals(Object arg)
(package private) ConnectionPoint	fetchRawConnectionPoint(Guid.IID iid)
protected void	finalize()
(package private) Guid.IID	getIID(ComInterface annotation)
<T> T	getProperty(Class<T> returnType, String name, Object... args)
IDispatch	getRawDispatch()
(package private) long	getUnknownId()
int	hashCode()
Object	invoke(Object proxy, Method method, Object[] args)
<T> T	invokeMethod(Class<T> returnType, String name, Object... args)
(package private) Object	invokeSynchronised(Object proxy, Method method, Object[] args)
protected WinNT.HRESULT	oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId)
protected WinNT.HRESULT	oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId, Variant.VARIANT pArg)
protected WinNT.HRESULT	oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, OaIdl.DISPID dispId, Variant.VARIANT[] pArgs)
protected WinNT.HRESULT	oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name)
protected WinNT.HRESULT	oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name, Variant.VARIANT pArg)
protected WinNT.HRESULT	oleMethod(int nType, Variant.VARIANT.ByReference pvResult, IDispatch pDisp, String name, Variant.VARIANT[] pArgs)
<T> T	queryInterface(Class<T> comInterface) Returns a proxy object for the given interface.
<T> void	setProperty(String name, T value)
String	toString()
void	unadvise(Class<?> comEventCallbackInterface, IComEventCallbackCookie cookie)

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

unknownId

long unknownId

theInterface

Class<?> theInterface

factory

Factory factory

comThread

ComThread comThread

rawDispatch

IDispatch rawDispatch

LOCALE_USER_DEFAULT

public static final WinDef.LCID LOCALE_USER_DEFAULT

The Constant LOCALE_USER_DEFAULT.

LOCALE_SYSTEM_DEFAULT

public static final WinDef.LCID LOCALE_SYSTEM_DEFAULT

The Constant LOCALE_SYSTEM_DEFAULT.

Constructor Detail

ProxyObject

public ProxyObject(Class<?> theInterface,
                   IDispatch rawDispatch,
                   Factory factory)

ProxyObject

ProxyObject(Class<?> theInterface,
            long unknownId,
            IDispatch rawDispatch,
            Factory factory)

when proxy is created for arguments on a call back, they are already on the com thread, and hence calling 'getUnknownId' will not work as it uses the ComThread however, the unknown pointer value is passed in;

Parameters:

theInterface -

unknownId -

rawDispatch -

factory -

Method Detail

getUnknownId

long getUnknownId()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

dispose

public void dispose(int r)

getRawDispatch

public IDispatch getRawDispatch()

Specified by:

getRawDispatch in interface IRawDispatchHandle

equals

public boolean equals(Object arg)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

invoke

public Object invoke(Object proxy,
                     Method method,
                     Object[] args)
              throws Throwable

Specified by:

invoke in interface InvocationHandler

Throws:

Throwable

invokeSynchronised

Object invokeSynchronised(Object proxy,
                          Method method,
                          Object[] args)
                   throws Throwable

Throws:

Throwable

fetchRawConnectionPoint

ConnectionPoint fetchRawConnectionPoint(Guid.IID iid)
                                 throws InterruptedException,
                                        ExecutionException,
                                        TimeoutException

Throws:

InterruptedException

ExecutionException

TimeoutException

advise

public IComEventCallbackCookie advise(Class<?> comEventCallbackInterface,
                                      IComEventCallbackListener comEventCallbackListener)

unadvise

public void unadvise(Class<?> comEventCallbackInterface,
                     IComEventCallbackCookie cookie)

setProperty

public <T> void setProperty(String name,
                            T value)

Specified by:

setProperty in interface IDispatch

getProperty

public <T> T getProperty(Class<T> returnType,
                         String name,
                         Object... args)

Specified by:

getProperty in interface IDispatch

invokeMethod

public <T> T invokeMethod(Class<T> returnType,
                          String name,
                          Object... args)

Specified by:

invokeMethod in interface IDispatch

queryInterface

public <T> T queryInterface(Class<T> comInterface)
                     throws COMException

Description copied from interface: IUnknown

Returns a proxy object for the given interface. Assuming that the interface is annotated with a ComInterface annotation that provides a valid iid. Will throw COMException if an error occurs trying to retrieve the requested interface, see exception cause for details.

Specified by:

queryInterface in interface IUnknown

Throws:

COMException

getIID

Guid.IID getIID(ComInterface annotation)

oleMethod

protected WinNT.HRESULT oleMethod(int nType,
                                  Variant.VARIANT.ByReference pvResult,
                                  IDispatch pDisp,
                                  String name,
                                  Variant.VARIANT pArg)
                           throws COMException

Throws:

COMException

oleMethod

protected WinNT.HRESULT oleMethod(int nType,
                                  Variant.VARIANT.ByReference pvResult,
                                  IDispatch pDisp,
                                  OaIdl.DISPID dispId,
                                  Variant.VARIANT pArg)
                           throws COMException

Throws:

COMException

oleMethod

protected WinNT.HRESULT oleMethod(int nType,
                                  Variant.VARIANT.ByReference pvResult,
                                  IDispatch pDisp,
                                  String name)
                           throws COMException

Throws:

COMException

oleMethod

protected WinNT.HRESULT oleMethod(int nType,
                                  Variant.VARIANT.ByReference pvResult,
                                  IDispatch pDisp,
                                  OaIdl.DISPID dispId)
                           throws COMException

Throws:

COMException

oleMethod

protected WinNT.HRESULT oleMethod(int nType,
                                  Variant.VARIANT.ByReference pvResult,
                                  IDispatch pDisp,
                                  String name,
                                  Variant.VARIANT[] pArgs)
                           throws COMException

Throws:

COMException

oleMethod

protected WinNT.HRESULT oleMethod(int nType,
                                  Variant.VARIANT.ByReference pvResult,
                                  IDispatch pDisp,
                                  OaIdl.DISPID dispId,
                                  Variant.VARIANT[] pArgs)
                           throws COMException

Throws:

COMException