Difference between revisions of "User:Frank Schönheit/Changing API incompatibly"
From Apache OpenOffice Wiki
Line 15: | Line 15: | ||
* [http://api.openoffice.org/docs/common/ref/com/sun/star/document/XFilter.html#filter XFilter::filter] should be allowed to throw exceptions (<code>InvalidArgument</code>, <code>InsufficentArguments</code>, or the like) | * [http://api.openoffice.org/docs/common/ref/com/sun/star/document/XFilter.html#filter XFilter::filter] should be allowed to throw exceptions (<code>InvalidArgument</code>, <code>InsufficentArguments</code>, or the like) | ||
− | * <code>XStorable::store<code> and friends should allow for a <code>WrappedTargetException<code>. This would allow implementations to wrap e.g. the <code>InteractiveAugmentedIOException</code> which can be thrown by usual UCB methods. | + | * <code>XStorable::store</code> and friends should allow for a <code>WrappedTargetException</code>. This would allow implementations to wrap e.g. the <code>InteractiveAugmentedIOException</code> which can be thrown by usual UCB methods. |
Revision as of 21:20, 25 August 2009
That's just my personal list of UNO APIs I would like to change incompatibly, if we are ever allowed to. Note there's much more than this. I just can't remember at the moment, but when working with API, I regularily encounter things which now will hopefully appear here over time.
various
- XRowSetSupplier:
setRowSet
should be allowed to throw a NoSupportException - There should be an interface merging XRow and XResultSet. Both are nearly always used together, and having to work with two interfaces, one for navigating through the result set, and one for querying the actual values, sucks.
- XContent should have direct access to selected properties. Asking for a given property by executing a command named
getPropertyValues
, which returns aXRow
/XResultSet
, through which you need to navigate, is absolutely ridiculous. - various XDatabaseMetaData methods should take
any
s instead of strings. For instance, getTables should take anany
for the schemaPattern, whereNULL
indicates "all schemas", as in JDBC. - XPropertyContainer::addProperty should allow for
NULL
defaults, by separating between the type of a property, and its default. - XSet should allow for for non-mutable implementations, by throwing a NoSupportException at the insert/remove method. For consistency reasons, this should then probably be extended to all container interfaces.
- XFilter::filter definitely needs to allow for more than a
RuntimeException
. At least aWrappedtTargetException
is mandatory here. - DoubleInitializationException and AlreadyInitializedException save the same purpose, so they should be consolidated into one exception class. And of course this new class should not reside in module
ucb
orframe
, but in some generic module (util
?lang
?beans
?). Probably, XInitialization.html::initialize should throw this exception then.
Exception declarations
- XFilter::filter should be allowed to throw exceptions (
InvalidArgument
,InsufficentArguments
, or the like) XStorable::store
and friends should allow for aWrappedTargetException
. This would allow implementations to wrap e.g. theInteractiveAugmentedIOException
which can be thrown by usual UCB methods.