public class MatchingRule extends AbstractSchemaObject
According to ldapbis [MODELS]:
4.1.3. Matching Rules Matching rules are used by servers to compare attribute values against assertion values when performing Search and Compare operations. They are also used to identify the value to be added or deleted when modifying entries, and are used when comparing a purported distinguished name with the name of an entry. A matching rule specifies the syntax of the assertion value. Each matching rule is identified by an object identifier (OID) and, optionally, one or more short names (descriptors). Matching rule definitions are written according to the ABNF: MatchingRuleDescription = LPAREN WSP numericoid ; object identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active SP "SYNTAX" SP numericoid ; assertion syntax extensions WSP RPAREN ; extensions where: [numericoid] is object identifier assigned to this matching rule; NAME [qdescrs] are short names (descriptors) identifying this matching rule; DESC [qdstring] is a short descriptive string; OBSOLETE indicates this matching rule is not active; SYNTAX identifies the assertion syntax by object identifier; and [extensions] describe extensions.
Modifier and Type | Field and Description |
---|---|
static long |
serialVersionUID
The mandatory serialVersionUID
|
Constructor and Description |
---|
MatchingRule(String oid)
Creates a new instance of MatchingRule.
|
Modifier and Type | Method and Description |
---|---|
MatchingRule |
copy()
Copy an MatchingRule
|
boolean |
equals(Object o) |
LdapComparator<? super Object> |
getLdapComparator()
Gets the LdapComparator enabling the use of this MatchingRule for ORDERING
and sorted indexing.
|
Normalizer |
getNormalizer()
Gets the Normalizer enabling the use of this MatchingRule for EQUALITY
matching and indexing.
|
LdapSyntax |
getSyntax()
Gets the LdapSyntax used by this MatchingRule.
|
String |
getSyntaxOid()
Gets the LdapSyntax OID used by this MatchingRule.
|
String |
toString() |
addExtension, addExtension, addName, clear, copy, getDescription, getExtension, getExtensions, getName, getNames, getObjectType, getOid, getSchemaName, getSpecification, hasExtension, hashCode, isDisabled, isEnabled, isObsolete, isReadOnly, lock, setDescription, setEnabled, setExtensions, setNames, setNames, setObsolete, setOid, setReadOnly, setSchemaName, setSpecification, unlock
public static final long serialVersionUID
public MatchingRule(String oid)
oid
- The MatchingRule OIDpublic LdapSyntax getSyntax()
public String getSyntaxOid()
public LdapComparator<? super Object> getLdapComparator()
public Normalizer getNormalizer()
public String toString()
toString
in class Object
Object.toString()
public MatchingRule copy()
public boolean equals(Object o)
AbstractSchemaObject
equals
in interface SchemaObject
equals
in class AbstractSchemaObject
Object.equals(Object)
Copyright © 2003–2018 The Apache Software Foundation. All rights reserved.