org.bytedeco.javacpp.annotation

Annotation Type Adapter

@Documented
 @Retention(value=RUNTIME)
 @Target(value={METHOD,PARAMETER,ANNOTATION_TYPE})
public @interface Adapter

Specifies a C++ class to act as an adapter to convert the types of arguments. Three such C++ classes made available by Generator are StringAdapter, VectorAdapter, and SharedPtrAdapter to bridge a few differences between std::string and String; between std::vector, Java arrays of primitive types, Buffer, and Pointer; and between xyz::shared_ptr and Pointer. Adapter classes must define the following public members:

• A constructor accepting 3 arguments (or more if argc() > 1): a pointer, a size, and the owner pointer
• Another constructor that accepts a reference to the object of the other class
• A static void deallocate(owner) function
• Overloaded cast operators to both types, for references and pointers
• A void assign(pointer, size, owner) function
• A size member variable for arrays accessed via pointer

To reduce further the amount of coding, this annotation can also be used on other annotations, such as with StdString, StdVector, and SharedPtr.

Author:

Samuel Audet

See Also:

Generator

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The name of the C++ adapter class.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	argc The number of arguments that Generator takes from the method as arguments to the adapter constructor.

Element Detail

value

public abstract String value

The name of the C++ adapter class.

argc

public abstract int argc

The number of arguments that Generator takes from the method as arguments to the adapter constructor.

Default:

1