io.sarl.lang.annotation

Annotation Type PrivateAPI

@Target(value={TYPE,METHOD,CONSTRUCTOR,FIELD})
 @Retention(value=CLASS)
public @interface PrivateAPI

Annotation for marking an element to be part of the private API as a feature provider.

Any reference to a private API type from the SARL code is forbidden, except if the caller's type is also marked with this annotation.

Since:

0.6

Version:

io.sarl.lang.core 0.12.0 20210527-171007

Author:

Stéphane Galland

Maven Group Id:

io.sarl.lang

Maven Artifact Id:

io.sarl.lang.core

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	isCallerOnly Indicate if the annotated element is a caller to the private API.

Element Detail

isCallerOnly

public abstract boolean isCallerOnly

Indicate if the annotated element is a caller to the private API.

Returns:

true if the annotated element is a caller to the private API, not a private API itself. false if the annotated element is both a caller to the private API, and a private API itself.

Default:

false