common/dev.ust.zinc.grader.annotation/InternalApi

InternalApi

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.ANNOTATION_CLASS, AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY_SETTER, AnnotationTarget.PROPERTY_GETTER])

annotation class InternalApi(val message: String, val replaceWith: ReplaceWith = ReplaceWith(""))

When applied to a declaration, marks the declaration as an internal API.

Internal APIs are APIs which are reserved for internal use only, typically within a single class or package. This annotation attempts to bridge the gap between design and language semantics.

For methods and constructors, usually this means the method should not be invoked directly by other classes in the class hierarchy, except the class specifying this annotation. For classes, usually this means the method should not be used outside of the package of the specified class.

Properties

message

val message: String

Message explaining the reason for the annotation.

replaceWith

val replaceWith: ReplaceWith

If present, specifies a code fragment which should be used in place of the API.