org.bytedeco.javacpp.annotation

Annotation Type Platform

@Documented
 @Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
public @interface 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.

A class or method annotated with only value() or not() lets Generator know for which platforms it should generate code (or not). The strings are matched with String.startsWith(String). In particular, @Platform(value="") matches all platforms, while @Platform(not="") matches no platforms, providing a way to specify methods to skip or classes to ignore, as if they did not exist.

Classes annotated with at least one of the other values define a top-enclosing class as returned by Loader.getEnclosingClass(Class). By default, one native library gets created for each such class, but Builder recognizes more than one class with the same library() name and produces only one library in that case.

Further, with the Properties annotation, properties can be inherited from other classes, and different properties can be defined for each platform.

Author:

Samuel Audet

See Also:

Builder, Generator, Loader

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	cinclude A list of C header files to include at the top of the generated code.
String[]	compiler A list of options applied for the native compiler.
String[]	define A list of macros to #define at the top of the generated code, before include() and cinclude() header files.
String[]	framework A list of frameworks the native compiler should build against.
String[]	frameworkpath A list of framework paths passed to the native compiler for use at link time.
String[]	include A list of C++ header files to include at the top of the generated code.
String[]	includepath A list of include paths passed to the native compiler.
String	library The native JNI library associated with this class that Builder should try to build and Loader should try to load.
String[]	link A list of libraries the native compiler should link with.
String[]	linkpath A list of library paths passed to the native compiler for use at link time.
String[]	not The properties, class, or method do NOT apply to the named platforms.
String[]	pragma A list of pragma directives to list at the top of the generated code, before define() macros and any included header files.
String[]	preload A list of libraries, in addition to link(), that should be extracted and preloaded, if possible.
String[]	preloadpath A list of paths from which to attempt preloading libraries from the link() and preload() lists.
String[]	value The properties, class, or method apply only to the named platforms.

Element Detail

value

public abstract String[] value

The properties, class, or method apply only to the named platforms. The strings are matched with String.startsWith(String)

Default:

{}

not

public abstract String[] not

The properties, class, or method do NOT apply to the named platforms. The strings are matched with String.startsWith(String)

Default:

{}

pragma

public abstract String[] pragma

A list of pragma directives to list at the top of the generated code, before define() macros and any included header files.

Default:

{}

define

public abstract String[] define

A list of macros to #define at the top of the generated code, before include() and cinclude() header files.

Default:

{}

include

public abstract String[] include

A list of C++ header files to include at the top of the generated code.

Default:

{}

cinclude

public abstract String[] cinclude

A list of C header files to include at the top of the generated code. The #include directives will be generated in a extern "C" { } block.

Default:

{}

includepath

public abstract String[] includepath

A list of include paths passed to the native compiler.

Default:

{}

compiler

public abstract String[] compiler

A list of options applied for the native compiler. The options here refer to property names. The actual command line options of the native compiler are the values of these properties, which need to be defined elsewhere. On an empty array, the Builder uses the "platform.compiler.default" property.

Default:

{}

linkpath

public abstract String[] linkpath

A list of library paths passed to the native compiler for use at link time.

Default:

{}

link

public abstract String[] link

A list of libraries the native compiler should link with.

Default:

{}

frameworkpath

public abstract String[] frameworkpath

A list of framework paths passed to the native compiler for use at link time.

Default:

{}

framework

public abstract String[] framework

A list of frameworks the native compiler should build against.

Default:

{}

preloadpath

public abstract String[] preloadpath

A list of paths from which to attempt preloading libraries from the link() and preload() lists.

Default:

{}

preload

public abstract String[] preload

A list of libraries, in addition to link(), that should be extracted and preloaded, if possible.

Default:

{}

library

public abstract String library

The native JNI library associated with this class that Builder should try to build and Loader should try to load. If left empty, this value defaults to "jni" + the name that Class.getSimpleName() returns.

Default:

""