Package com.atlassian.annotations

package com.atlassian.annotations
Contains a set of annotations that are used to identify and document a product's API. API elements carry with them a guarantee of binary compatibility with future versions, meaning that clients that are compiled against version X are generally guaranteed to run on version X+1 without needing to be recompiled (the exact guarantee will vary depending on the product's API policy).

Binary compatibility is defined in chapter 13 of the Java Language Specification.

  • Annotation Interfaces
    Class
    Description
    ConfiguredByServiceProperty
    Mark a method whose implementation can be configured by properties from the service environment.
    ExperimentalApi
    Indicates that program elements that this annotation is applied to is considered usable by external developers but its contracts have not stabilized.
    ExperimentalSpi
    Indicates that program elements that this annotation is applied to is considered usable by external developers but its contracts have not stabilized.
    Internal
    The annotated element is an internal implementation detail and will change without notice.
    JIRA
    Used to annotate source to indicate related issues For example - annotations to test method for some bug
    PublicApi
    The annotated element is part of a product's API contract with plugins.
    PublicSpi
    The annotated element is part of a product's SPI contract with plugins.
    Scopes
    Deprecated.
    StagedRollout
    Mark a code construct whose usage or implementation is changing as part of a staged feature rollout.
    VisibleForTesting
    Annotates a program element that exists, or is more widely visible than otherwise necessary, only for use in test code.