com4j

Enum NativeType

java.lang.Object

java.lang.Enum<NativeType>

com4j.NativeType

All Implemented Interfaces:

Serializable, Comparable<NativeType>

public enum NativeType
extends Enum<NativeType>

Native method type.

Author:

Kohsuke Kawaguchi (kk@kohsuke.org)

Enum Constant Summary

Enum Constants

Enum Constant and Description
Bool The native type is 'BOOL' (defined as 'int') where true maps to -1 and false maps to 0.
BSTR BSTR.
BSTR_ByRef BSTR*.
ComObject COM interface pointer.
ComObject_ByRef COM interface pointer by reference.
CSTR String will be marshaled as "char*".
Currency CURRENCY.
Currency_ByRef
Date DATE.
Default The native type is determined from the Java method return type.
Dispatch IDispatch*
Double double.
Double_ByRef
Float float.
Float_ByRef
GUID GUID.
HRESULT Used only with ReturnValue for returning HRESULT of the method invocation as "int".
Int16 INT16 (short).
Int16_ByRef Int16 passed by reference
Int32 Marshalled as 32-bit integer.
Int32_ByRef
Int64 Marshalled as 64-bit integer.
Int64_ByRef
Int8 INT8 (byte).
Int8_ByRef Int8 passed by reference TODO should we add enum message/unmessage?
PVOID PVOID.
PVOID_ByRef void**.
SafeArray SAFEARRAY.
Unicode LPWSTR.
VARIANT VARIANT.
VARIANT_ByRef VARIANT*.
VariantBool The native type is 'VARIANT_BOOL' where TRUE=1 and FALSE=0.
VariantBool_ByRef

Method Summary

Methods

Modifier and Type	Method and Description
NativeType	byRef() If the constant has the BYREF version, return it.
NativeType	getNoByRef()
static NativeType	valueOf(String name) Returns the enum constant of this type with the specified name.
static NativeType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BSTR

public static final NativeType BSTR

BSTR. TODO: support CharSequence

Expected Java type: String

BSTR_ByRef

public static final NativeType BSTR_ByRef

BSTR*. TODO: support StringBuffer

Expected Java type: Holder<String>

Unicode

public static final NativeType Unicode

LPWSTR. More concretely, it becomes a L'\0'-terminated UTF-16LE format.

CSTR

public static final NativeType CSTR

String will be marshaled as "char*".

More concretely, it becomes a '\0'-terminated multi-byte string where characters are encoded according to the platform default encoding.

For example, on a typical English Windows system this is just an ASCII string (more or less). On a typical Japanese Windows system, this is Shift-JIS.

Int8

public static final NativeType Int8

INT8 (byte).

Expected Java type: byte Number

Int8_ByRef

public static final NativeType Int8_ByRef

Int8 passed by reference TODO should we add enum message/unmessage?

Int16

public static final NativeType Int16

INT16 (short).

Expected Java type: short Number

Int16_ByRef

public static final NativeType Int16_ByRef

Int16 passed by reference

Int32

public static final NativeType Int32

Marshalled as 32-bit integer.

Java "int" is 32 bit.

Expected Java type: int Number Enum (see ComEnum)

Int32_ByRef

public static final NativeType Int32_ByRef

Bool

public static final NativeType Bool

The native type is 'BOOL' (defined as 'int') where true maps to -1 and false maps to 0.

Expected Java type: boolean Boolean

VariantBool

public static final NativeType VariantBool

The native type is 'VARIANT_BOOL' where TRUE=1 and FALSE=0. Note that sizeof(VARIANT_BOOL)==2.

Expected Java type: boolean Boolean

VariantBool_ByRef

public static final NativeType VariantBool_ByRef

Int64

public static final NativeType Int64

Marshalled as 64-bit integer.

Java "long" is 64 bit.

Expected Java type: long Number

Int64_ByRef

public static final NativeType Int64_ByRef

Float

public static final NativeType Float

float.

Expected Java type: boolean Number

Float_ByRef

public static final NativeType Float_ByRef

Double

public static final NativeType Double

double.

Expected Java type: boolean Number

Double_ByRef

public static final NativeType Double_ByRef

HRESULT

public static final NativeType HRESULT

Used only with ReturnValue for returning HRESULT of the method invocation as "int".

Default

public static final NativeType Default

The native type is determined from the Java method return type. See the documentation for more details. TODO: link to the doc.

ComObject

public static final NativeType ComObject

COM interface pointer.

Expected Java type: Com4jObject

ComObject_ByRef

public static final NativeType ComObject_ByRef

COM interface pointer by reference.

Expected Java type: Holder<ComObject>

GUID

public static final NativeType GUID

GUID.

Passed by reference in COM convention but it doesn't have the "out" semantics.

Expected Java type: GUID

VARIANT

public static final NativeType VARIANT

VARIANT.

Expected Java type: Variant Object

When the Java type is Object, the type of the created VARIANT is determined at run-time from the actual type of the Java object being passed in. The following table describes this inferene process:

Java type	COM VARIANT type
Boolean / boolean	VT_BOOL
String	VT_BSTR
Float / float	VT_R4
Double / double	VT_R8
Short / short	VT_I2
Integer / int	VT_I4
Long / long	VT_I8
Com4jObject or its derived types	VT_UNKNOWN

TODO: expand the list

VARIANT_ByRef

public static final NativeType VARIANT_ByRef

VARIANT*.

This works like VARIANT, except that a reference is passed, instead of a VARIANT itself.

Dispatch

public static final NativeType Dispatch

IDispatch*

Expected Java type: Com4jObject

PVOID

public static final NativeType PVOID

PVOID.

The assumed semantics is that a region of buffer will be passed to the native method.

Expected Java type: direct Buffers (Buffers created from methods like ByteBuffer.allocateDirect(int)

PVOID_ByRef

public static final NativeType PVOID_ByRef

void**.

The assumed semantics is that you receive a buffer.

Expected Java type: Holder<Buffer> (Buffers created from methods like ByteBuffer.allocateDirect(int)

Date

public static final NativeType Date

DATE. See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/vccore/html/_core_The_DATE_Type.asp

Expected Java type: Date Calendar

Currency

public static final NativeType Currency

CURRENCY. According to MSDN:

CURRENCY is implemented as an 8-byte two's-complement integer value scaled by 10,000. This gives a fixed-point number with 15 digits to the left of the decimal point and 4 digits to the right. The CURRENCY data type is extremely useful for calculations involving money, or for any fixed-point calculations where accuracy is important.

Expected Java type: BigDecimal

Currency_ByRef

public static final NativeType Currency_ByRef

SafeArray

public static final NativeType SafeArray

SAFEARRAY.

The given java type is converted into a SAFEARRAY before passed to the native method. When the Java type is an array, the component type of the SAFEARRAY is automatically derived from the component type of the Java array. This inference is defined as follows:

• boolean[] -> SAFEARRAY(VT_BOOL)
• byte[] -> SAFEARRAY(VT_UI1)
• char[] -> SAFEARRAY(VT_UI2) (??? is this right?)
• short[] -> SAFEARRAY(VT_I2)
• int[] -> SAFEARRAY(VT_I4)
• long[] -> SAFEARRAY(VT_I8)
• float[] -> SAFEARRAY(VT_R4)
• double[] -> SAFEARRAY(VT_R8)
• Object[] -> SAFEARRAY(VT_VARIANT)
• String[] -> SAFEARRAY(VT_BSTR)

Method Detail

values

public static NativeType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (NativeType c : NativeType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static NativeType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

byRef

public final NativeType byRef()

If the constant has the BYREF version, return it. Otherwise null.

getNoByRef

public final NativeType getNoByRef()