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

Class ObjectClassDescriptionSchemaParser

java.lang.Object

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

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

public class ObjectClassDescriptionSchemaParser
extends AbstractSchemaParser<ObjectClass>

A parser for RFC 4512 object class descriptons

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

Method Summary

Modifier and Type	Method and Description
protected ObjectClass	doParse() Parse a SchemaObject description and returns back an instance of SchemaObject.
ObjectClass	parseObjectClassDescription(String objectClassDescription) Parses a object class definition 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

ObjectClassDescriptionSchemaParser

public ObjectClassDescriptionSchemaParser()

Creates a schema parser instance.

Method Detail

parseObjectClassDescription

public ObjectClass parseObjectClassDescription(String objectClassDescription)
                                        throws ParseException

Parses a object class definition according to RFC 4512:

 ObjectClassDescription = LPAREN WSP
     numericoid                 ; object identifier
     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
     [ SP "DESC" SP qdstring ]  ; description
     [ SP "OBSOLETE" ]          ; not active
     [ SP "SUP" SP oids ]       ; superior object classes
     [ SP kind ]                ; kind of class
     [ SP "MUST" SP oids ]      ; attribute types
     [ SP "MAY" SP oids ]       ; attribute types
     extensions WSP RPAREN

 kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
 
 extensions = *( SP xstring SP qdstrings )
 xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
 

Parameters:

objectClassDescription - the object class description to be parsed

Returns:

the parsed ObjectClassDescription bean

Throws:

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

doParse

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

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

Specified by:

doParse in class AbstractSchemaParser<ObjectClass>

Returns:

A SchemaObject instance

Throws:

antlr.RecognitionException - the native antlr exception

antlr.TokenStreamException - the native antlr exception