From cb3d67cf61f9c3a75b0cf74dbb26830f9d137093 Mon Sep 17 00:00:00 2001 From: pjack Date: Thu, 22 Aug 2002 02:08:32 +0000 Subject: [PATCH] Added some notes about the abstraction layers. git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/collections/trunk@130808 13f79535-47bb-0310-9956-ffa450edef68 --- .../commons/collections/primitives/package.html | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/java/org/apache/commons/collections/primitives/package.html b/src/java/org/apache/commons/collections/primitives/package.html index e176a6ee6..818003c1d 100644 --- a/src/java/org/apache/commons/collections/primitives/package.html +++ b/src/java/org/apache/commons/collections/primitives/package.html @@ -1,3 +1,18 @@ -Contains collection implementations that use primitive elements. +Contains collection implementations that use primitive elements. Currently +the package offers lists of primitive elements that are backed by primitive +arrays, offering substantial memory and performance savings.

+ +There are generally two layers of abstract per primitive list type. The +first layer, implemented by the Abstract*List classes, provides +default implementations for all of the java.util.List methods +and most of their primitive counterparts. The second layer of abstraction, +implemented by the Abstract*ArrayList classes, provides +additional method signatures for manipulating a list that's backed by a +primitive array.

+ +Note that these layers are not provided for FloatArrayList, +and that many primitive types are not represented in this package at all; +these inconsistencies may be addressed by a future release. +