7aa6718020
Summary: Fixed javadoc comments that were causing warnings at build time. git-svn-id: svn://10.0.0.236/trunk@226263 18797224-902f-48f8-a5cc-f745e15eee43
82 lines
3.1 KiB
Java
82 lines
3.1 KiB
Java
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1999
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
package netscape.ldap;
|
|
|
|
/**
|
|
* The <CODE>LDAPEntryComparator</CODE> interface represents the
|
|
* algorithm used to sort the search results. This interface specifies
|
|
* one method, <CODE>isGreater</CODE>, which compares two entries and
|
|
* determines the order in which the two entries should be sorted.
|
|
* <P>
|
|
*
|
|
* The <CODE>netscape.ldap</CODE> package includes a class that
|
|
* implements this interface. The <CODE>LDAPCompareAttrNames</CODE>
|
|
* class represents a comparator that sorts the two entries alphabetically,
|
|
* based on the value of one or more attributes.
|
|
* <P>
|
|
*
|
|
* When calling the <CODE>sort</CODE> method of the
|
|
* <CODE>LDAPSearchResults</CODE> class, you need to specify
|
|
* a class that implements the <CODE>LDAPEntryComparator</CODE>
|
|
* interface.
|
|
* <P>
|
|
*
|
|
* @version 1.0
|
|
* @see netscape.ldap.LDAPCompareAttrNames
|
|
* @see netscape.ldap.LDAPSearchResults#sort
|
|
*/
|
|
public interface LDAPEntryComparator {
|
|
|
|
/**
|
|
* Specifies the algorithm used to
|
|
* compare entries when sorting search results.
|
|
* <P>
|
|
*
|
|
* <CODE>isGreater</CODE> returns <CODE>true</CODE>
|
|
* if the entry specified in the first argument should
|
|
* be sorted before the entry specified in the second
|
|
* argument.
|
|
* <P>
|
|
*
|
|
* @see netscape.ldap.LDAPCompareAttrNames
|
|
* @see netscape.ldap.LDAPSearchResults#sort
|
|
*/
|
|
public boolean isGreater (LDAPEntry greater, LDAPEntry less);
|
|
|
|
}
|