@Export
Package org.bytedeco.javacpp.annotation
Contains all the annotation classes used by JavaCPP.
-
Annotation Types Summary Annotation Type Description Adapter Specifies a C++ class to act as an adapter between a target type and one or more adaptee type(s).Allocator An annotation indicating that a method should behave like an allocator.ArrayAllocator An annotation indicating that a method should behave like an array allocator.AsUtf16 Indicates thatString
should be mapped to array of UTF-16 code units (unsigned short*
) instead of byte array (const char*
).ByPtr Indicates that an argument should get passed or returned by pointer.ByPtrPtr Indicates that an argument gets passed or returned by a pointer to a pointer.ByPtrRef Indicates that an argument gets passed or returned by a reference to a pointer.ByRef Indicates that an argument gets passed or returned by reference.ByVal Indicates that an argument gets passed or returned by value.Cast Indicates a type cast required on the argument to satisfy the native compiler.Const A shortcut annotation toCast
that simply addsconst
to the parameter type, function, or class.Convention Specifies the calling convention of aFunctionPointer
.CriticalRegion In some methods,Generator
will generate code to transfer arrays from the JVM to native code using theGet/Release<primitivetype>ArrayElements
methods.Function Overrides the detection of allocators, getters, and setters.Index Allows using method arguments to calloperator[]
in some circumstances.MemberGetter An annotation indicating that a method should behave like a member getter.MemberSetter An annotation indicating that a method should behave like a member setter.Name Names the identifier of a native C++ struct, class, union, function, variable, operator, macro, etc.Namespace Encloses the scope of a Java class inside the scope of the given C++ namespace.NoDeallocator By default, all allocators attach a deallocator to the peer object on creation.NoException By default,Generator
assumes all native functions may throw exceptions.NoOffset By default,Generator
appliesoffsetof()
to all member variables.Opaque This annotation must be used for native types that get declared but not defined.Optional A shorthand for@Adapter("OptionalAdapter<type>")
.Platform Defines native properties for a top-level enclosing class as well as indicates classes and methods that should be generated or not, for specified platforms.Properties Makes it possible to define more than one set of properties for each platform.Raw Allows passing and returning Java objects with native functions and raw JNI types.SharedPtr A shorthand for@Adapter("SharedPtrAdapter<type>")
.StdBasicString StdMove A shorthand for@Adapter("MoveAdapter<type>")
.StdString A shorthand for@Cast("std::string&") @Adapter("StringAdapter<char>")
.StdU16String StdU32String StdVector A shorthand for@Adapter("VectorAdapter<type>")
.StdWString A shorthand for@Cast("std::wstring&") @Adapter("StringAdapter<wchar_t>")
.UniquePtr A shorthand for@Adapter("UniquePtrAdapter<type>")
.ValueGetter An annotation indicating that a method should behave like a value getter.ValueSetter An annotation indicating that a method should behave like a value setter.Virtual Indicates that a method maps to a virtual function in C++.