Return-Path: 
 <lucene-dev-return-8336-apmail-jakarta-lucene-dev-archive=jakarta.apache.org@jakarta.apache.org>
Delivered-To: apmail-jakarta-lucene-dev-archive@www.apache.org
Received: (qmail 1445 invoked from network); 23 Nov 2004 20:56:28 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
  by minotaur-2.apache.org with SMTP; 23 Nov 2004 20:56:28 -0000
Received: (qmail 76971 invoked by uid 500); 23 Nov 2004 20:56:08 -0000
Delivered-To: apmail-jakarta-lucene-dev-archive@jakarta.apache.org
Received: (qmail 76928 invoked by uid 500); 23 Nov 2004 20:56:08 -0000
Mailing-List: contact lucene-dev-help@jakarta.apache.org; run by ezmlm
Precedence: bulk
List-Unsubscribe: <mailto:lucene-dev-unsubscribe@jakarta.apache.org>
List-Subscribe: <mailto:lucene-dev-subscribe@jakarta.apache.org>
List-Help: <mailto:lucene-dev-help@jakarta.apache.org>
List-Post: <mailto:lucene-dev@jakarta.apache.org>
List-Id: "Lucene Developers List" <lucene-dev.jakarta.apache.org>
Reply-To: "Lucene Developers List" <lucene-dev@jakarta.apache.org>
Delivered-To: mailing list lucene-dev@jakarta.apache.org
Received: (qmail 76913 invoked by uid 500); 23 Nov 2004 20:56:08 -0000
Received: (qmail 76896 invoked by uid 99); 23 Nov 2004 20:56:08 -0000
X-ASF-Spam-Status: No, hits=-10.0 required=10.0
	tests=ALL_TRUSTED,NO_REAL_NAME
X-Spam-Check-By: apache.org
Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194)
  by apache.org (qpsmtpd/0.28) with SMTP; Tue, 23 Nov 2004 12:56:07 -0800
Received: (qmail 1316 invoked by uid 1912); 23 Nov 2004 20:56:06 -0000
Date: 23 Nov 2004 20:56:06 -0000
Message-ID: <20041123205606.1315.qmail@minotaur.apache.org>
From: dnaber@apache.org
To: jakarta-lucene-cvs@apache.org
Subject: cvs commit: jakarta-lucene/src/java/org/apache/lucene/search
 RangeFilter.java
X-Virus-Checked: Checked
X-Spam-Rating: minotaur-2.apache.org 1.6.2 0/1000/N

dnaber      2004/11/23 12:56:06

  Modified:    src/java/org/apache/lucene/search RangeFilter.java
  Log:
  some small javadoc improvements
  
  Revision  Changes    Path
  1.2       +9 -8      jakarta-lucene/src/java/org/apache/lucene/search/RangeFilter.java
  
  Index: RangeFilter.java
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/search/RangeFilter.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- RangeFilter.java	23 Nov 2004 14:17:18 -0000	1.1
  +++ RangeFilter.java	23 Nov 2004 20:56:06 -0000	1.2
  @@ -1,7 +1,5 @@
   package org.apache.lucene.search;
   
  -
  -
   /**
    * Copyright 2004 The Apache Software Foundation
    *
  @@ -32,8 +30,8 @@
    * field.
    * 
    * <p>
  - * This code borrows heavily from {@link RangeQuery}, but implemented as a Filter
  - * (much like {@link DateFilter})
  + * This code borrows heavily from {@link RangeQuery}, but is implemented as a Filter
  + * (much like {@link DateFilter}).
    * </p>
    */
   public class RangeFilter extends Filter {
  @@ -50,6 +48,9 @@
        * @param upperTerm The upper bound on this range
        * @param includeLower Does this range include the lower bound?
        * @param includeUpper Does this range include the upper bound?
  +     * @throws IllegalArgumentException if both terms are null or if
  +     *  lowerTerm is null and includeLower is true (similar for upperTerm
  +     *  and includeUpper)
        */
       public RangeFilter(String fieldName, String lowerTerm, String upperTerm,
                          boolean includeLower, boolean includeUpper) {
  @@ -74,16 +75,16 @@
       }
       
       /**
  -     * Constructs a filter for field <code>field</code> matching
  -     * less than or equal to <code>value</code>
  +     * Constructs a filter for field <code>fieldName</code> matching
  +     * less than or equal to <code>upperTerm</code>.
        */
       public static RangeFilter Less(String fieldName, String upperTerm) {
           return new RangeFilter(fieldName, null, upperTerm, false, true);
       }
   
       /**
  -     * Constructs a filter for field <code>field</code> matching
  -     * greater than or equal to <code>lower</code>
  +     * Constructs a filter for field <code>fieldName</code> matching
  +     * greater than or equal to <code>lowerTerm</code>.
        */
       public static RangeFilter More(String fieldName, String lowerTerm) {
           return new RangeFilter(fieldName, lowerTerm, null, true, false);
  
  
  

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