Package org.ldaptive.schema

Class MatchingRuleUse

java.lang.Object

org.ldaptive.AbstractFreezable

org.ldaptive.schema.AbstractSchemaElement<T>

org.ldaptive.schema.AbstractNamedSchemaElement<String>

org.ldaptive.schema.MatchingRuleUse

All Implemented Interfaces:

Freezable, NamedElement, SchemaElement<String>

public final class MatchingRuleUse
extends AbstractNamedSchemaElement<String>

Bean for a matching rule use schema element.

   MatchingRuleUseDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
     [ SP "DESC" SP qdstring ]  ; description
     [ SP "OBSOLETE" ]          ; not active
     SP "APPLIES" SP oids       ; attribute types
     extensions WSP RPAREN      ; extensions
 

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private String[]	appliesAttributeTypes	Superior classes.
private static final int	HASH_CODE_SEED	hash code seed.
private final String	oid	OID.

Constructor Summary

Constructors

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

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<MatchingRuleUse> formatter)	Returns a string representation of this element.
String[]	getAppliesAttributeTypes()	Returns the applies attribute types.
String	getElementKey()	Returns the key for this element.
String	getOID()	Returns the oid.
int	hashCode()
static MatchingRuleUse	parse(String definition)	Parses the supplied definition string and creates an initialized matching rule use.
void	setAppliesAttributeTypes(String... s)	Sets the applies attribute types.
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.

appliesAttributeTypes

private String[] appliesAttributeTypes

Superior classes.

Constructor Details

MatchingRuleUse

public MatchingRuleUse(String s)

Creates a new matching rule use.

Parameters:

s - oid

MatchingRuleUse

public MatchingRuleUse(String oid,
 String[] names,
 String description,
 boolean obsolete,
 String[] appliesAttributeTypes,
 Extensions extensions)

Creates a new matching rule use.

Parameters:

oid - oid

names - names

description - description

obsolete - obsolete

appliesAttributeTypes - applies attribute types

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

getAppliesAttributeTypes

public String[] getAppliesAttributeTypes()

Returns the applies attribute types.

Returns:

attribute types

setAppliesAttributeTypes

public void setAppliesAttributeTypes(String... s)

Sets the applies attribute types.

Parameters:

s - attribute types

parse

public static MatchingRuleUse parse(String definition)
                             throws SchemaParseException

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

Parameters:

definition - to parse

Returns:

matching rule use

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<MatchingRuleUse> 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