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

matthew_swift
07.36.2007 12b0ce03d0029bb96bb23cc288ea351a8a1bec75
refs
author matthew_swift <matthew_swift@localhost>
Friday, December 7, 2007 18:36 +0100
committer matthew_swift <matthew_swift@localhost>
Friday, December 7, 2007 18:36 +0100
commit12b0ce03d0029bb96bb23cc288ea351a8a1bec75
tree 88341e8a97b772a612454eaaf137acc4cc7e5a5b tree | zip | gz
parent 64c313e7a5ec07b4ea41d9f5953bf8c438bdfcfe view | diff
This relates to issue 2661 "public APIs must not reference private classes".

The classes in org.opends.messages need to be made public so that they can be referenced from other public APIs. This change adds the PublicAPI annotation to the classes defined in this package as follows:

* the org.opends.messages package is VOLATILE

* the org.opends.messages core classes (Message, MessageDescriptor,
MessageBuilder, Category, and Severity) are all UNCOMMITTED

* the class org.opends.messages.MessageDescriptorRegistry is PRIVATE
(it's only used in unit tests)

* generated message classes are PRIVATE

In addition minor cleanup was made to the classes where appropriate to make them suitable for public APIs:

* used "final" where possible

* reduced visibility of classes, methods, and members where appropriate

* fixed some potential bugs spotted during this clean-up: class
members not being initialized (the "final" keyword is useful for
spotting this!)

* added missing javadoc

* I've removed the third-party and user-defined message generation
since we could see know way in which they could be easily used
without impacting core OpenDS source
2 files deleted
10 files modified
431 ■■■■■ changed files
opends/build.xml 10 ●●●●● diff | view | raw | blame | history
opends/resource/Messages.java.stub 18 ●●●● diff | view | raw | blame | history
opends/src/messages/messages/third_party.properties 49 ●●●●● diff | view | raw | blame | history
opends/src/messages/messages/user_defined.properties 49 ●●●●● diff | view | raw | blame | history
opends/src/messages/src/org/opends/messages/Category.java 7 ●●●● diff | view | raw | blame | history
opends/src/messages/src/org/opends/messages/Message.java 20 ●●●●● diff | view | raw | blame | history
opends/src/messages/src/org/opends/messages/MessageBuilder.java 17 ●●●● diff | view | raw | blame | history
opends/src/messages/src/org/opends/messages/MessageDescriptor.java 214 ●●●● diff | view | raw | blame | history
opends/src/messages/src/org/opends/messages/MessageDescriptorRegistry.java 18 ●●●●● diff | view | raw | blame | history
opends/src/messages/src/org/opends/messages/Severity.java 11 ●●●● diff | view | raw | blame | history
opends/src/messages/src/org/opends/messages/package-info.java 2 ●●●●● diff | view | raw | blame | history
opends/tests/unit-tests-testng/src/server/org/opends/messages/MessageDescriptorRegistryTest.java 16 ●●●●● diff | view | raw | blame | history