Annotation Interface ExpectedEnvironment


@Documented @Retention(CLASS) @Target(TYPE) public @interface ExpectedEnvironment
Applied to declare that the annotated element only works as intended in the specified environment.

This indicates that the annotated element, while present in both environments, should as much as possible, only be used in the specified environment, as its usage in different environments may yield to unexpected behavior different from the documented behavior.

This annotation only discourages usage in non-specified environments due to possible unexpected behaviors present in the non-specified environment, as the annotated element stil exists in both environments.
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Returns the environment type that the annotated element works as intended in.
  • Element Details

    • value

      EnvType value
      Returns the environment type that the annotated element works as intended in.