org.fusesource.hawtjni.runtime

Enum MethodFlag

java.lang.Object

java.lang.Enum<MethodFlag>

org.fusesource.hawtjni.runtime.MethodFlag

All Implemented Interfaces:

Serializable, Comparable<MethodFlag>

public enum MethodFlag
extends Enum<MethodFlag>

Author:

Hiram Chirino

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADDER Indicate that the native method takes 2 arguments, a collection and an item, and the += operator is used to add the item to the collection.
ADDRESS Indicate that the native method represents a structure global variable and the address of it should be returned to Java.
CAST Indicate that the C function should be casted to a prototype generated from the parameters of the native method.
CONSTANT_GETTER Indicate that the native method represents a constant or global variable instead of a function.
CONSTANT_INITIALIZER Indicate that this method will be the constant initializer for the class.
CPP_DELETE Indicate that the native method is a C++ destructor that deallocates an object from the heap.
CPP_METHOD Indicate that the native method is calling a C++ object's method.
CPP_NEW Indicate that the native method is a C++ constructor that allocates an object on the heap.
CS_NEW Indicate that the native method is a C# constructor that allocates an object on the managed (i.e. garbage collected) heap.
CS_OBJECT Indicate that the native method's return value is a C# managed object.
DYNAMIC Indicate that a native method should be looked up dynamically.
GETTER Indicate that the native method represents a getter for a field in an object or structure.
JNI Indicate that the native is part of the Java Native Interface.
METHOD_SKIP Indicate that the item should not be generated.
POINTER_RETURN Indicate that the return value is a pointer.
SETTER Indicate that the native method represents a setter for a field in an object or structure

Method Summary

Modifier and Type	Method and Description
static MethodFlag	valueOf(String name) Returns the enum constant of this type with the specified name.
static MethodFlag[]	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

METHOD_SKIP

public static final MethodFlag METHOD_SKIP

Indicate that the item should not be generated. For example, custom natives are coded by hand.

DYNAMIC

public static final MethodFlag DYNAMIC

Indicate that a native method should be looked up dynamically. It is useful when having a dependence on a given library is not desirable. The library name is specified in the *_custom.h file.

CONSTANT_GETTER

public static final MethodFlag CONSTANT_GETTER

Indicate that the native method represents a constant or global variable instead of a function. This omits () from the generated code.

CAST

public static final MethodFlag CAST

Indicate that the C function should be casted to a prototype generated from the parameters of the native method. Useful for variable argument C functions.

JNI

public static final MethodFlag JNI

Indicate that the native is part of the Java Native Interface. For example: NewGlobalRef().

ADDRESS

public static final MethodFlag ADDRESS

Indicate that the native method represents a structure global variable and the address of it should be returned to Java. This is done by prepending &.

CPP_METHOD

public static final MethodFlag CPP_METHOD

Indicate that the native method is calling a C++ object's method.

CPP_NEW

public static final MethodFlag CPP_NEW

Indicate that the native method is a C++ constructor that allocates an object on the heap.

CPP_DELETE

public static final MethodFlag CPP_DELETE

Indicate that the native method is a C++ destructor that deallocates an object from the heap.

CS_NEW

public static final MethodFlag CS_NEW

Indicate that the native method is a C# constructor that allocates an object on the managed (i.e. garbage collected) heap.

CS_OBJECT

public static final MethodFlag CS_OBJECT

Indicate that the native method's return value is a C# managed object.

SETTER

public static final MethodFlag SETTER

Indicate that the native method represents a setter for a field in an object or structure

GETTER

public static final MethodFlag GETTER

Indicate that the native method represents a getter for a field in an object or structure.

ADDER

public static final MethodFlag ADDER

Indicate that the native method takes 2 arguments, a collection and an item, and the += operator is used to add the item to the collection.

POINTER_RETURN

public static final MethodFlag POINTER_RETURN

Indicate that the return value is a pointer.

CONSTANT_INITIALIZER

public static final MethodFlag CONSTANT_INITIALIZER

Indicate that this method will be the constant initializer for the class. When called, it will set all the static constant fields to the values defined in your platform.

Method Detail

values

public static MethodFlag[] 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 (MethodFlag c : MethodFlag.values())
    System.out.println(c);

Returns:

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

valueOf

public static MethodFlag 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