diff --git a/DEVELOPERS-GUIDE.html b/DEVELOPERS-GUIDE.html index a4897bb28..690c9511c 100644 --- a/DEVELOPERS-GUIDE.html +++ b/DEVELOPERS-GUIDE.html @@ -8,7 +8,7 @@

The Jakarta Commons Collections Package

Developers Guide

-$Id: DEVELOPERS-GUIDE.html,v 1.1 2002/06/29 03:49:01 mas Exp $
+$Id: DEVELOPERS-GUIDE.html,v 1.2 2002/07/03 02:34:09 mas Exp $
[Introduction] [Collection Interfaces] [Collection Implementations] @@ -80,13 +80,20 @@ functionality interface -

Where the method in a Utils class is a decorator, the naming pattern -yyyedXxx shall be used, such as synchronizedMap(Map) or -predicatedSet(Set). Typically, these decorators should be -implemented as non-public, static, inner classes; however, if warranted due to -maintenance or other reasons, these decorator classes may be moved to top-level -classes in a subpackage. The naming of such a subpackage should be discussed -and agreed upon on the developers mailing list.

+

Where the method in a Utils class is a decorator, the name shall consist of +an adjective followed by the collection type. Typically such adjective is +formed by appending an -ed suffix (meaning "having"/"characterized by") to the +word describing the type of decorator. For example, +synchronizedMap(Map) or predicatedSet(Set). +Occasionally, such construct is awkward and a more suitable adjective can be +used instead. For example, lazyList, +unmodifiableList.

+ +

Typically, these decorators should be implemented as non-public, static, +inner classes; however, if warranted due to maintenance or other reasons, these +decorator classes may be moved to top-level classes in a subpackage. The +naming of such a subpackage should be discussed and agreed upon on the +developers mailing list.