Package org.forgerock.openam.annotations

Annotation Interface SupportedAll

@SupportedAll @Retention(RUNTIME) @Documented @Target({PACKAGE,TYPE,ANNOTATION_TYPE}) public @interface SupportedAll
This annotation marks AM APIs that are considered stable and should not change in minor releases (except possibly when a security fix requires such change). Backwards incompatible changes made to APIs marked with this annotation should be highlighted in the release notes of major releases.

The scope of the annotation is limited to the component that is annotated and all of its child components. In other words, if a class is marked with SupportedAll, all constructors, fields and methods within that class are considered supported.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    javaApi
    Setting this parameter to false for a Supported annotation allows this method to be excluded from the published java API.
    boolean
    scriptingApi
    When a ElementType.TYPE has this parameter set to true, all of its methods are available for use as script bindings when scripting additional features is enabled.

  • Element Details

    • scriptingApi

      boolean scriptingApi
      When a ElementType.TYPE has this parameter set to true, all of its methods are available for use as script bindings when scripting additional features is enabled.

      This parameter should be set at ElementType.TYPE level. It has no effect on other Targets.

      This parameter is applied to every method in the class, however it can be overridden at ElementType.METHOD level using the Supported annotation for more fine-grained control.

      Returns:
      true if all methods in this class are available in scripts when scripting additional features is enabled.
      Default:
      false

    • javaApi

      boolean javaApi
      Setting this parameter to false for a Supported annotation allows this method to be excluded from the published java API.
      Returns:
      true this class, type, method is included in the Java API.
      Default:
      true