Package org.ldaptive.schema

Class MatchingRule

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.schema.AbstractSchemaElement<T>

org.ldaptive.schema.AbstractNamedSchemaElement<String>

org.ldaptive.schema.MatchingRule

All Implemented Interfaces:

Freezable, NamedElement, SchemaElement<String>

public final class MatchingRule
extends AbstractNamedSchemaElement<String>

Bean for a matching rule schema element.

   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
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MatchingRule.DefaultDefinitionFunction	Parses a matching rule definition using a char buffer.
static class	MatchingRule.DefaultSchemaElementFormatter	Creates a string representation of a matching rule.
static class	MatchingRule.RegexDefinitionFunction	Parses a matching rule definition using a regular expression.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	HASH_CODE_SEED	hash code seed.
private final String	oid	OID.
private String	syntaxOID	Syntax OID.

Constructor Summary

Constructors

Constructor	Description
MatchingRule(String s)	Creates a new matching rule.
MatchingRule(String oid, String[] names, String description, boolean obsolete, String syntaxOID, Extensions extensions)	Creates a new matching rule.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	format()	Returns this schema element as formatted string per RFC 4512.
String	format(SchemaElementFormatter<MatchingRule> formatter)	Returns a string representation of this element.
String	getElementKey()	Returns the key for this element.
String	getOID()	Returns the oid.
String	getSyntaxOID()	Returns the syntax oid.
int	hashCode()
static MatchingRule	parse(String definition)	Parses the supplied definition string and creates an initialized matching rule.
void	setSyntaxOID(String s)	Sets the syntax oid.
String	toString()

Methods inherited from class org.ldaptive.schema.AbstractNamedSchemaElement

getName, getNames, hasName, isObsolete, setNames, setObsolete

Methods inherited from class org.ldaptive.schema.AbstractSchemaElement

containsBooleanExtension, freeze, getDescription, getExtensions, setDescription, setExtensions

Methods inherited from class org.ldaptive.AbstractFreezable

assertMutable, freeze, freeze, isFrozen

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

HASH_CODE_SEED

private static final int HASH_CODE_SEED

hash code seed.

See Also:

• Constant Field Values

oid

private final String oid

OID.

syntaxOID

private String syntaxOID

Syntax OID.

Constructor Details

MatchingRule

public MatchingRule(String s)

Creates a new matching rule.

Parameters:

s - oid

MatchingRule

public MatchingRule(String oid,
 String[] names,
 String description,
 boolean obsolete,
 String syntaxOID,
 Extensions extensions)

Creates a new matching rule.

Parameters:

oid - oid

names - names

description - description

obsolete - obsolete

syntaxOID - syntax OID

extensions - extensions

Method Details

getElementKey

public String getElementKey()

Description copied from interface: SchemaElement

Returns the key for this element. Typically, an OID but may also be an integer.

Returns:

element key

getOID

public String getOID()

Returns the oid.

Returns:

oid

getSyntaxOID

public String getSyntaxOID()

Returns the syntax oid.

Returns:

syntax oid

setSyntaxOID

public void setSyntaxOID(String s)

Sets the syntax oid.

Parameters:

s - syntax oid

parse

public static MatchingRule parse(String definition)
                          throws SchemaParseException

Parses the supplied definition string and creates an initialized matching rule.

Parameters:

definition - to parse

Returns:

matching rule

Throws:

SchemaParseException - if the supplied definition is invalid

format

public String format()

Description copied from interface: SchemaElement

Returns this schema element as formatted string per RFC 4512.

Returns:

formatted string

format

public String format(SchemaElementFormatter<MatchingRule> formatter)

Returns a string representation of this element.

Parameters:

formatter - to format this element

Returns:

formatted schema element

equals

public boolean equals(Object o)

Overrides:

equals in class AbstractSchemaElement<String>

hashCode

public int hashCode()

Specified by:

hashCode in class AbstractSchemaElement<String>

toString

public String toString()

Overrides:

toString in class Object