mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

neil_a_wilson
13.15.2007 884c76c873708430081e906d7fe36556d2360c1b
refs
author neil_a_wilson <neil_a_wilson@localhost>
Monday, August 13, 2007 17:15 +0200
committer neil_a_wilson <neil_a_wilson@localhost>
Monday, August 13, 2007 17:15 +0200
commit884c76c873708430081e906d7fe36556d2360c1b
tree 4d80f309c4679835c2c57d61037d5de2a1ce3cf5 tree | zip | gz
parent 96083f30c02e9a5683887279fa8d7a1995e34d1b view | diff
Add a new @PublicAPI annotation type that can be used later to mark OpenDS
packages, classes, and methods to indicate what part (if any) they play in the
OpenDS public API. This annotation type can be useful for documentation
purposes, for helping to verify whether third-party code is using appropriate
interfaces, and ensuring that what we declare as our public API does not change
in an inappropriate way between releases.

This commit also introduces a new StabilityLevel enumeration that can be used
to indicate the likelihood that the associated code will change in an
incompatible manner in the future.

Comments in the @PublicAPI annotation type and the StabilityLevel enum should
adequately describe their purpose and intended use. At the present time, none
of the OpenDS code uses them, but we will add the @PublicAPI annotation to
OpenDS code where appropriate before the 1.0 release in order to help define
what is included in our public API.

Note that checkstyle analysis is currently disabled for this annotation type
because of an apparent checkstyle limitation that does not support the use of
Javadoc comments in methods used to define annotation type properties.
2 files added
1 files modified
292 ■■■■■ changed files
opendj-sdk/opends/build.xml 5 ●●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/server/org/opends/server/types/PublicAPI.java 153 ●●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/server/org/opends/server/types/StabilityLevel.java 134 ●●●●● diff | view | raw | blame | history