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

Class DitContentRuleDescriptionSchemaParser

java.lang.Object

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

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

public class DitContentRuleDescriptionSchemaParser
extends AbstractSchemaParser<DitContentRule>

A parser for RFC 4512 DIT content rule descriptions.

Field Summary

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

lexer, LOG, monitor, parser

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected DitContentRule	doParse() Parse a SchemaObject description and returns back an instance of SchemaObject.
DitContentRule	parseDITContentRuleDescription(java.lang.String ditContentRuleDescription) Parses a DIT content rule description according to RFC 4512:

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

isQuirksMode, parse, reset, setParserMonitor, setQuirksMode

Methods inherited from class java.lang.Object

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

Constructor Detail

DitContentRuleDescriptionSchemaParser

public DitContentRuleDescriptionSchemaParser()

Creates a schema parser instance.

Method Detail

parseDITContentRuleDescription

public DitContentRule parseDITContentRuleDescription(java.lang.String ditContentRuleDescription)
                                              throws java.text.ParseException

Parses a DIT content rule description according to RFC 4512:

 DITContentRuleDescription = LPAREN WSP
    numericoid                 ; object identifier
    [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
    [ SP "DESC" SP qdstring ]  ; description
    [ SP "OBSOLETE" ]          ; not active
    [ SP "AUX" SP oids ]       ; auxiliary object classes
    [ SP "MUST" SP oids ]      ; attribute types
    [ SP "MAY" SP oids ]       ; attribute types
    [ SP "NOT" SP oids ]       ; attribute types
    extensions WSP RPAREN      ; extensions
 

Parameters:

ditContentRuleDescription - the DIT content rule description to be parsed

Returns:

the parsed DITContentRuleDescription bean

Throws:

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

doParse

protected DitContentRule doParse()
                          throws antlr.RecognitionException,
                                 antlr.TokenStreamException

Parse a SchemaObject description and returns back an instance of SchemaObject.

Specified by:

doParse in class AbstractSchemaParser<DitContentRule>

Returns:

A SchemaObject instance

Throws:

antlr.RecognitionException - the native antlr exception

antlr.TokenStreamException - the native antlr exception