org.apache.directory.shared.ldap.schema.parsers

Class MatchingRuleUseDescriptionSchemaParser

java.lang.Object

org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser

org.apache.directory.shared.ldap.schema.parsers.MatchingRuleUseDescriptionSchemaParser

public class MatchingRuleUseDescriptionSchemaParser
extends AbstractSchemaParser

A parser for RFC 4512 matching rule use descriptions.

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.slf4j.Logger	LOG The LoggerFactory used by this class

Fields inherited from class org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser

lexer, monitor, parser

Constructor Summary

Constructors

Constructor and Description
MatchingRuleUseDescriptionSchemaParser() Creates a schema parser instance.

Method Summary

Modifier and Type	Method and Description
MatchingRuleUse	parse(String schemaDescription) Parses a MatchingRuleUse description
MatchingRuleUse	parseMatchingRuleUseDescription(String matchingRuleUseDescription) Parses a matching rule use description according to RFC 4512:

Methods inherited from class org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser

isQuirksMode, reset, setParserMonitor, setQuirksMode, setSchemaName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

protected static final org.slf4j.Logger LOG

The LoggerFactory used by this class

Constructor Detail

MatchingRuleUseDescriptionSchemaParser

public MatchingRuleUseDescriptionSchemaParser()

Creates a schema parser instance.

Method Detail

parseMatchingRuleUseDescription

public MatchingRuleUse parseMatchingRuleUseDescription(String matchingRuleUseDescription)
                                                throws ParseException

Parses a matching rule use description according to RFC 4512:

 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
 
 extensions = *( SP xstring SP qdstrings )
 xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 
 

Parameters:

matchingRuleUseDescription - the matching rule use description to be parsed

Returns:

the parsed MatchingRuleUseDescription bean

Throws:

ParseException - if there are any recognition errors (bad syntax)

parse

public MatchingRuleUse parse(String schemaDescription)
                      throws ParseException

Parses a MatchingRuleUse description

Specified by:

parse in class AbstractSchemaParser

Parameters:

The - MatchingRuleUse description to parse

Returns:

An instance of MatchingRuleUse

Throws:

ParseException - If the parsing failed