@Retention(value=RUNTIME) @Target(value=METHOD) public @interface CEntryPoint
An execution context must be passed as a parameter and can be either an
that is specific to the current thread, or an
Isolate for an isolate in which the current
thread is attached. These pointers can be obtained via the methods of
When there is more than one parameter of these types, exactly one of the parameters must be
Exceptions cannot be thrown to the caller and must be explicitly caught in the entry point method. Any uncaught exception causes the termination of the process after it is printed.
No object types are permitted for parameters or return types; only primitive Java values,
word values, and enum values are allowed. Enum values are automatically
converted from integer constants to Java enum object constants. The enum class must have a
CEnum annotation. When enum values are passed as parameters, the enum class must have a
method with a
CEnumLookup annotation. For enum return types, the enum class must have a
method that is annotated with
|Modifier and Type||Optional Element and Description|
Specifies that the annotated entry point method is an alias for a built-in function as provided by the C API.
Method documentation to be included in the header file, as an array of lines.
Provides an exception handler for all exceptions that are not handled explicitly by the entry point method.
If the supplier returns
The symbol name to use for this entry point.
Whether the entry point is part of the symbols and header files produced by Native Image.
public abstract String name
public abstract String documentation
public abstract Class<? extends CEntryPoint.ExceptionHandler> exceptionHandler
The provided class must have exactly one declared method (the exception handler method). The
method must be static, have one parameter of type
must have a return type that is assignable to the return type of the annotated entry point
method. That exception handler method is invoked when an exception reaches the entry point,
and the exception is passed as the argument. The return value of the exception handler method
is then the return value of the entry point, i.e., passed back to the C code.
public abstract CEntryPoint.Builtin builtin
nativeand as such, cannot have its own code body. Refer to the C API for descriptions of the built-ins, and to the individual built-ins for their requirements to the annotated method's signature.
public abstract Class<? extends BooleanSupplier> include
true, this entry point is added automatically when building a shared library. This means the method is a root method for compilation, and everything reachable from it is compiled too. The provided class must have a nullary constructor, which is used to instantiate the class. Then the supplier function is called on the newly instantiated instance.
public abstract CEntryPoint.Publish publishAs