Mailing-List: contact dev-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Commons Developers List" <dev@commons.apache.org>
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
From: Apache Wiki <wikidiffs@apache.org>
To: Apache Wiki <wikidiffs@apache.org>
Date: Sat, 21 Jan 2012 01:59:56 -0000
Message-ID: <20120121015956.58983.58095@eos.apache.org>
Subject: 
 =?utf-8?q?=5BCommons_Wiki=5D_Update_of_=22Sanity_Check_of_APIs=2C_etc=2E?=
 =?utf-8?q?=22_by_MattBenson?=
Auto-Submitted: auto-generated

Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Commons Wiki" for c=
hange notification.

The "Sanity Check of APIs, etc." page has been changed by MattBenson:
http://wiki.apache.org/commons/Sanity%20Check%20of%20APIs%2C%20etc.

New page:
Address open questions:

 * there are several marker interfaces, but maybe some annotations would ma=
ke more sense?

 * couldn't Function, UnaryFunction and BinaryFunction be unified with a si=
ngle interface using a vararg parameter?

 * EachElement should be able to work on any Iterable. Also I'm not sure to=
 understand why its constructor is public.

 * Shouldn't Generator implement Iterable?

 * why are equals, hashCode and toString defined in the Functor interface?

 * why Predicate isn't an extension of Function<Boolean> ?

 * why Procedure isn't an extension of Function<Void> ?

 * Why are constants available through both a static field AND a static met=
hod? For example Identity.INSTANCE and Identify.instance(), or Constant.TRU=
E and Constant.truePredicate() ?

 * The Javadoc for Limit states "A predicate that returns true the first n =
times it is invoked.", but what happens after? Is it the opposite of Offset?

 * Why aren't Limit and Offset serializable like the other classes in the c=
ore package?

 * Limit and Offset could probably use an AtomicInteger instead of a synchr=
onized block

 * the site has no example easily accessible, the reader is invited to brow=
se the JUnit tests. That's not really user friendly.

 * I see IllegalArgumentExceptions thrown for null values, shouldn't this b=
e changed to throw NullPointerExceptions ?

 * @inheritDoc tags should be removed if no additional description is provi=
ded in the subclasses. This tag is only useful for extending the descriptio=
n from the method of the super class.

 * what's the point of having equals(T) methods in addition to equals(Objec=
t) ? It clutters the API.

 * CollectionTransformer has a todo stating : "TODO revisit this class..."

 * There are several untested classes in the composite package

 * Most of the equals/hashcode methods are not tested

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org