org.jinterop.dcom.core

Class JILocalParamsDescriptor

java.lang.Object

org.jinterop.dcom.core.JILocalParamsDescriptor

All Implemented Interfaces:

Serializable

public final class JILocalParamsDescriptor
extends Object
implements Serializable

Provides a way to express parameters for a particular method. These are only [in] parameters, the [out] parameters are decided at the implementation level. If the IDL method being described by this class is returning multiple objects then use the return type of the implementation as an Object[]

For example:-
IDL from Microsoft Internet Explorer is:-
[id(0x000000fb), helpstring("A new, hidden, non-navigated WebBrowser window is needed.")]
void NewWindow2( [in, out] IDispatch** ppDisp, [in, out] VARIANT_BOOL* Cancel);

Corresponding JILocalParamsDescriptor would be :-
JILocalParamsDescriptor paramObject = new JILocalParamsDescriptor();
paramObject.addInParamAsObject(new JIPointer(IJIComObject.class,false), JIFlags.FLAG_NULL);
paramObject.addInParamAsType(JIVariant.class,JIFlags.FLAG_NULL);
and the Java implementation must return an Object[] in this case, for returning the 2 parameters back.

Please refer to MSInternetExplorer, Test_ITestServer2_Impl, SampleTestServer and MSShell examples for more details on how to use this class.

Since:

2.0 (formerly JIParameterObject)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JILocalParamsDescriptor()

Method Summary

Modifier and Type	Method and Description
void	addInParamAsObject(Object param, int FLAGS) Add [in] parameter at the end of the out parameter list.
void	addInParamAsType(Class clazz, int FLAGS) Add [in] parameter of the type clazz at the end of the out parameter list.
void	removeInParamAt(int index, int FLAGS) Removes [in] parameter at the specified index from the parameter list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JILocalParamsDescriptor

public JILocalParamsDescriptor()

Method Detail

addInParamAsType

public void addInParamAsType(Class clazz,
                             int FLAGS)

Add [in] parameter of the type clazz at the end of the out parameter list.

Parameters:

clazz -

FLAGS -

addInParamAsObject

public void addInParamAsObject(Object param,
                               int FLAGS)

Add [in] parameter at the end of the out parameter list. Typically callers are composite in nature JIStruct , JIUnions , JIPointer and JIString .

Parameters:

param -

FLAGS -

removeInParamAt

public void removeInParamAt(int index,
                            int FLAGS)

Removes [in] parameter at the specified index from the parameter list.

Parameters:

index - 0 based index

FLAGS - from JIFlags (if need be).