lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Michael Busch (JIRA)" <>
Subject [jira] Closed: (LUCENE-1439) Inconsistent API
Date Fri, 07 Nov 2008 15:00:52 GMT


Michael Busch closed LUCENE-1439.

    Resolution: Incomplete

I agree that there are several APIs that could be improved in Lucene. However, opening an
issue like this is not very helpful.

Please open a more specific issue for a particular API you'd like to fix, attach a patch that
deprecates the old one, introduces a new one, maintains backwards-compatibility and provides
unit tests. (see LUCENE-1422 as a current example).

If you don't want to provide such a patch then you can also start a discussion on the mailinglists
and suggest API improvements.

> Inconsistent API 
> -----------------
>                 Key: LUCENE-1439
>                 URL:
>             Project: Lucene - Java
>          Issue Type: Bug
>    Affects Versions: 3.0
>         Environment: any
>            Reporter: Ivan.S
>            Priority: Minor
> The API of Lucene is totally inconsistent:
> 1)
> There are a lot of containers which don't implement an interface which indicates this
> (for pre-java-1.5 Lucene it could be Collection, for post-ajva-1.5 Lucene it could be
more general Iterable)
> Example:
>  IndexSearcher: "int maxDoc()" and "doc(int i)"
> 2)
> There are a lot of classes having non-final public accessible fields.
> 3)
> Some methods which return values are named something() others are named getSomething()
> Best one is: Fieldable:
> without get: String stringValue(), Reader readerValue(), byte[] binaryValue(), ...
> with get: byte[] getBinaryValue(), int getBinaryLength(), ...

This message is automatically generated by JIRA.
You can reply to this email to add a comment to the issue online.

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message