Package org.ldaptive.control
Class SortKey
java.lang.Object
org.ldaptive.control.SortKey
Used by
SortRequestControl
to declare how sorting should occur. See RFC 3698 for the definition of
matchingRuleId.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the attribute description.Returns the matching rule id.boolean
Returns whether results should be in reverse sorted order.int
hashCode()
void
Sets the attribute description.void
Sets the matching rule id.void
setReverseOrder
(boolean b) Sets whether results should be in reverse sorted order.toString()
-
Field Details
-
HASH_CODE_SEED
private static final int HASH_CODE_SEEDhash code seed.- See Also:
-
attributeDescription
attribute description. -
matchingRuleId
matching rule id. -
reverseOrder
private boolean reverseOrderreverse order.
-
-
Constructor Details
-
SortKey
public SortKey()Default constructor. -
SortKey
Creates a new sort key.- Parameters:
attrDescription
- attribute description
-
SortKey
Creates a new sort key.- Parameters:
attrDescription
- attribute descriptionruleId
- matching rule id
-
SortKey
Creates a new sort key.- Parameters:
attrDescription
- attribute descriptionruleId
- matching rule idreverse
- reverse order
-
-
Method Details
-
getAttributeDescription
Returns the attribute description.- Returns:
- attribute description
-
setAttributeDescription
Sets the attribute description.- Parameters:
s
- attribute description
-
getMatchingRuleId
Returns the matching rule id.- Returns:
- matching rule id
-
setMatchingRuleId
Sets the matching rule id.- Parameters:
s
- matching rule id
-
getReverseOrder
public boolean getReverseOrder()Returns whether results should be in reverse sorted order.- Returns:
- whether results should be in reverse sorted order
-
setReverseOrder
public void setReverseOrder(boolean b) Sets whether results should be in reverse sorted order.- Parameters:
b
- whether results should be in reverse sorted order
-
equals
-
hashCode
public int hashCode() -
toString
-