com4j

Class DefaultedComMethod

java.lang.Object

com4j.DefaultedComMethod

public class DefaultedComMethod
extends Object

ComMethod that calls default methods.

This is used so that the user can do foo() whereas the real COM method invocation goes like foo().bar().zot().

Author:

Kohsuke Kawaguchi

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	defaultParameterIndex The parameter indexes of default parameters.
protected Object[]	defaultParameters The array of default parameters of the COM methods
protected Method	method The Java method that corresponds to the native COM method

Constructor Summary

Constructors

Constructor and Description
DefaultedComMethod(Method m, ReturnValue retVal)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	generateDefaultParameters(UseDefaultValues defValues) Generates the default values for this ComMethod using the given UseDefaultValues annotation
protected void	messageParameters(Object[] args) Converts the parameters to be more native friendly.

Methods inherited from class java.lang.Object

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

Field Detail

method

protected final Method method

The Java method that corresponds to the native COM method

defaultParameters

protected final Object[] defaultParameters

The array of default parameters of the COM methods

See Also:

defaultParameterIndex

defaultParameterIndex

protected final int[] defaultParameterIndex

The parameter indexes of default parameters. Each position in this array corresponds to a position in defaultParameters

Example

Let's assume the following values:

  defaultParameterIndex = {2, 4};
  defaultParameters = {new Integer(3), "Hello"};
  

In this example the second parameter of the ComMethod has a default value of new Integer(3) and the forth parameter has a default value of "Hello".

See Also:

defaultParameters

Constructor Detail

DefaultedComMethod

public DefaultedComMethod(Method m,
                  ReturnValue retVal)

Method Detail

messageParameters

protected void messageParameters(Object[] args)

Converts the parameters to be more native friendly.

Parameters:

args - the array of objects to be converted.

generateDefaultParameters

protected void generateDefaultParameters(UseDefaultValues defValues)

Generates the default values for this ComMethod using the given UseDefaultValues annotation

Parameters:

defValues - the annotation containing the information to generate the default values.