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

matthew_swift
07.36.2007 8d363b60e9cb04609592c2368f550c2ea8a6ab34
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
commit8d363b60e9cb04609592c2368f550c2ea8a6ab34
tree 8b9d1e592428322184c7e358b99377b8d2ec2291 tree | zip | gz
parent c54152b31aa3fafead7737a4ff7b2b4c1cd1e030 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
opendj-sdk/opends/build.xml 10 ●●●●● diff | view | raw | blame | history
opendj-sdk/opends/resource/Messages.java.stub 18 ●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/messages/third_party.properties 49 ●●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/messages/user_defined.properties 49 ●●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/src/org/opends/messages/Category.java 7 ●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/src/org/opends/messages/Message.java 20 ●●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/src/org/opends/messages/MessageBuilder.java 17 ●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/src/org/opends/messages/MessageDescriptor.java 214 ●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/src/org/opends/messages/MessageDescriptorRegistry.java 18 ●●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/src/org/opends/messages/Severity.java 11 ●●●● diff | view | raw | blame | history
opendj-sdk/opends/src/messages/src/org/opends/messages/package-info.java 2 ●●●●● diff | view | raw | blame | history
opendj-sdk/opends/tests/unit-tests-testng/src/server/org/opends/messages/MessageDescriptorRegistryTest.java 16 ●●●●● diff | view | raw | blame | history