uima-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Adam Lally" <ala...@alum.rpi.edu>
Subject Re: Pear installer API
Date Fri, 01 Dec 2006 14:22:09 GMT
On 12/1/06, Michael Baessler <mba@michael-baessler.de> wrote:
> OK, thanks for the responses. I changed the classnames to
> PackageInstaller and PackageInstallerException.
> Have a separate exception for verification error seems not necessary to me.
>
> I also removed the two method arguments localInstall and
> installToRootDir. But we should document that to the install
> directory the componentId of the pear file is added automatically. I
> will work on the documentation for this.
> Having the two method overloads (pearFile, installDirPath) and
> (pearFile, installDirPath, verify) seems not very helpful
> for the user/developer from my perspective. I think it is sufficient to
> have (pearFile, installDirPath, verify).
>

+1 with the only caveat that the classes need Javadoc comments.  I
think they should lead with something like "The main user API for
installing pear packages" that would help the user find this class if
they were scanning through the Javadocs looking for how to install
pears.

-Adam

Mime
View raw message