Package org.apache.pekko.annotation

Annotation Interface InternalStableApi

@Documented
@Retention(CLASS)
@Target({METHOD,CONSTRUCTOR,FIELD,TYPE,PACKAGE})
public @interface InternalStableApi

Marks APIs that are considered internal to Apache Pekko and should not be accessed by user code but that are used across Apache Pekko project boundaries and therefore shouldn't be changed without considering possible usage outside of the Apache Pekko core modules.

If a method/class annotated with this annotation is part of a public API and has the Scala private[pekko] access restriction, which leads to a public method from Java, there should be a javadoc/scaladoc comment where the first line MUST include INTERNAL API in order to be easily identifiable from generated documentation. Additional information may be put on the same line as the INTERNAL API comment in order to clarify further.