Annotation Type Internal


Elements annotated @Internal are -- although possibly exported -- intended for Oak's internal use only. Such elements are not public by design and likely to be removed, have their signature change, or have their access level decreased in future versions without notice. @Internal elements are eligible for immediate modification or removal and are not subject to any policies with respect to deprecation.

Note that Oak APIs are considered internal use by default, unless the package they appear in is annotated with a Version annotation with a value greater than "1.0.0".

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
     
     
  • Element Details

    • reason

      String reason
      Returns:
      (optional) reason for being internal
      Default:
      ""
    • since

      String since
      Returns:
      (optional) first package version making this API internal
      Default:
      ""