org.apache.directory.api.ldap.model.schema.parsers

Class DitStructureRuleDescriptionSchemaParser

java.lang.Object

org.apache.directory.api.ldap.model.schema.parsers.AbstractSchemaParser<DitStructureRule>

org.apache.directory.api.ldap.model.schema.parsers.DitStructureRuleDescriptionSchemaParser

public class DitStructureRuleDescriptionSchemaParser
extends AbstractSchemaParser<DitStructureRule>

A parser for RFC 4512 DIT structure rule descriptions.

Author:

Apache Directory Project

Field Summary

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

fastParser, LOG

Constructor Summary

Constructors

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

Method Summary

Modifier and Type

Method and Description

DitStructureRule

parse(String ditStructureRuleDescription) Parses a DIT structure rule description according to RFC 4512: DITStructureRuleDescription = LPAREN WSP ruleid ; rule identifier [ SP "NAME" SP qdescrs ] ; short names (descriptors) [ SP "DESC" SP qdstring ] ; description [ SP "OBSOLETE" ] ; not active SP "FORM" SP oid ; NameForm [ SP "SUP" ruleids ] ; superior rules extensions WSP RPAREN ; extensions ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN ) ruleidlist = ruleid *( SP ruleid ) ruleid = numbers

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

getObjectIdentifiers, isQuirksMode, setQuirksMode, updateSchemaName

Methods inherited from class java.lang.Object

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

Constructor Detail

DitStructureRuleDescriptionSchemaParser

public DitStructureRuleDescriptionSchemaParser()

Creates a schema parser instance.

Method Detail

parse

public DitStructureRule parse(String ditStructureRuleDescription)
                       throws ParseException

Parses a DIT structure rule description according to RFC 4512:

 DITStructureRuleDescription = LPAREN WSP
   ruleid                     ; rule identifier
   [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
   [ SP "DESC" SP qdstring ]  ; description
   [ SP "OBSOLETE" ]          ; not active
   SP "FORM" SP oid           ; NameForm
   [ SP "SUP" ruleids ]       ; superior rules
   extensions WSP RPAREN      ; extensions

 ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN )
 ruleidlist = ruleid *( SP ruleid )
 ruleid = numbers
 

Specified by:

parse in class AbstractSchemaParser<DitStructureRule>

Parameters:

ditStructureRuleDescription - the DIT structure rule description to be parsed

Returns:

the parsed DITStructureRuleDescription bean

Throws:

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