Mailing-List: contact java-dev-help@lucene.apache.org; run by ezmlm
Precedence: bulk
Reply-To: java-dev@lucene.apache.org
Message-ID: <743036895.1226653844421.JavaMail.jira@brutus>
Date: Fri, 14 Nov 2008 01:10:44 -0800 (PST)
From: "Ivan.S (JIRA)" <jira@apache.org>
To: java-dev@lucene.apache.org
Subject: [jira] Issue Comment Edited: (LUCENE-1439) Inconsistent API
In-Reply-To: <440273301.1226061285539.JavaMail.jira@brutus>
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit


    [ https://issues.apache.org/jira/browse/LUCENE-1439?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12647548#action_12647548 ] 

ivan.s edited comment on LUCENE-1439 at 11/14/08 1:09 AM:
----------------------------------------------------------

Can anyone open an umbrella bug for this?
I think we should first collect all inconsistencies, then someone (including me) start to make patches.

BTW one more thing I've noticed: some methods even start with uppercase.
Common, there are books written about Lucene, such things are just painful ;)
It needs a clear API.

I'm now using Lucene in a project, it helps, I like it. So I would like to contribute (my time and) patches after
we've sorted out, what the inconsistencies are, sort them by priority, and collect their locations.

Umbrella bug or not?

      was (Author: ivan.s):
    Can anyone open an umbrella bug for this?
I think we should first collect all inconsistencies, then someone (including me) start to make patches.

BTW one more think I've noticed: some methods even start with uppercase.
Common, there are books written about Lucene, such things are just painful ;)
It needs a clear API.

I'm now using Lucene in a project, it helps, I like it. So I would like to contribute (my time and) patches after
we've sorted out, what the inconsistencies are, sort them by priority, and collect their locations.

Umbrella bug or not?
  
> Inconsistent API 
> -----------------
>
>                 Key: LUCENE-1439
>                 URL: https://issues.apache.org/jira/browse/LUCENE-1439
>             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 fact
> (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: java-dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: java-dev-help@lucene.apache.org