This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.naming.ldap
class SortKey
public class SortKey
extends Object
A sort key and its associated sort parameters.
This class implements a sort key which is used by the LDAPv3
Control for server-side sorting of search results as defined in
RFC 2891.
Constructor Summary |
Creates the default sort key for an attribute.
|
Creates a sort key for an attribute.
|
Method Summary |
String |
Retrieves the attribute ID of the sort key.
|
String |
Retrieves the matching rule ID used to order the attribute values.
|
boolean |
Determines the sort order.
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
SortKey
public SortKey(String attrID)
-
Creates the default sort key for an attribute. Entries will be sorted
according to the specified attribute in ascending order using the
ordering matching rule defined for use with that attribute.
- Parameters:
attrID
- The non-null ID of the attribute to be used as a sort
key.
SortKey
public SortKey(String attrID,
boolean ascendingOrder,
String matchingRuleID)
-
Creates a sort key for an attribute. Entries will be sorted according to
the specified attribute in the specified sort order and using the
specified matching rule, if supplied.
- Parameters:
attrID
- The non-null ID of the attribute to be used as
a sort key.
ascendingOrder
- If true then entries are arranged in ascending
order. Otherwise there are arranged in
descending order.
matchingRuleID
- The possibly null ID of the matching rule to
use to order the attribute values. If not
specified then the ordering matching rule
defined for the sort key attribute is used.
getAttributeID
public String getAttributeID()
-
Retrieves the attribute ID of the sort key.
- Returns:
- The non-null Attribute ID of the sort key.
getMatchingRuleID
public String getMatchingRuleID()
-
Retrieves the matching rule ID used to order the attribute values.
- Returns:
- The possibly null matching rule ID. If null then the
ordering matching rule defined for the sort key attribute
is used.
isAscending
public boolean isAscending()
-
Determines the sort order.
- Returns:
- true if the sort order is ascending, false if descending.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
This page displays the
Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
The official Sun™ documentation can be found here at
http://java.sun.com/javase/6/docs/api/.