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

Class NameFormDescriptionSchemaParser

java.lang.Object

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

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

public class NameFormDescriptionSchemaParser
extends AbstractSchemaParser<NameForm>

A parser for RFC 4512 name form descriptions

Author:

Apache Directory Project

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
NameFormDescriptionSchemaParser() Creates a schema parser instance.

Method Summary

Modifier and Type	Method and Description
protected NameForm	doParse() Parse a SchemaObject description and returns back an instance of SchemaObject.
NameForm	parseNameFormDescription(String nameFormDescription) Parses a name form 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

NameFormDescriptionSchemaParser

public NameFormDescriptionSchemaParser()

Creates a schema parser instance.

Method Detail

parseNameFormDescription

public NameForm parseNameFormDescription(String nameFormDescription)
                                  throws ParseException

Parses a name form description according to RFC 4512:

 NameFormDescription = LPAREN WSP
    numericoid                 ; object identifier
    [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
    [ SP "DESC" SP qdstring ]  ; description
    [ SP "OBSOLETE" ]          ; not active
    SP "OC" SP oid             ; structural object class
    SP "MUST" SP oids          ; attribute types
    [ SP "MAY" SP oids ]       ; attribute types
    extensions WSP RPAREN      ; extensions
 

Parameters:

nameFormDescription - the name form description to be parsed

Returns:

the parsed NameForm bean

Throws:

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

doParse

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

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

Specified by:

doParse in class AbstractSchemaParser<NameForm>

Returns:

A SchemaObject instance

Throws:

antlr.RecognitionException - the native antlr exception

antlr.TokenStreamException - the native antlr exception