com4j

Annotation Type ReturnValue

@Retention(value=RUNTIME)
@Target(value=METHOD)
public @interface ReturnValue

Specifies which method parameter in the COM method is used as the return value

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<? extends Com4jObject>[]	defaultPropertyThrough Indicates that the return value is actually a result from invoking default properties.
int	index The index of the parameter with [retval] marker.
boolean	inout True if the [retval] parameter is "in/out" (therefore it also shows up in the Java parameter list.) Otherwise, the return value is not a part of the Java parameter list.
NativeType	type The native type to be unmarshalled.

Element Detail

index

public abstract int index

The index of the parameter with [retval] marker.

If 0, the retval parameter is the 1st parameter in the parameter list. The default value '-1' means the return value is the last parameter.

If the method has the return type void, the COM method is assumed to have no return value (regardless of this annotation.)

Default:

-1

inout

public abstract boolean inout

True if the [retval] parameter is "in/out" (therefore it also shows up in the Java parameter list.) Otherwise, the return value is not a part of the Java parameter list.

Default:

false

type

public abstract NativeType type

The native type to be unmarshalled.

Default:

com4j.NativeType.Default

defaultPropertyThrough

public abstract Class<? extends Com4jObject>[] defaultPropertyThrough

Indicates that the return value is actually a result from invoking default properties.

For example, when the underlying type definitions are as follows:

 interface IFoo {
   @VTID(10)
   IBar abc();
 }
 interface IBar {
   @DefaultProperty
   IZot def();
 }
 interface IZot {
   @
   int value(int index);
 }
 

The following method on the IFoo interface effectively works as a short-cut of the following chain:

 IFoo {
   @ReturnValue(defaultPropertyThrough={IFoo.class,IBar.class})
   @VTID(10)
   int abc(int index);
 }

 // equivalent
 pFoo.value(5);
 pFoo.abc().def().value(5);
 

Default:

{}