org.apache.directory.shared.ldap.schema.syntax.parser
Class ObjectClassDescriptionSchemaParser

java.lang.Object
  extended by org.apache.directory.shared.ldap.schema.syntax.parser.AbstractSchemaParser
      extended by org.apache.directory.shared.ldap.schema.syntax.parser.ObjectClassDescriptionSchemaParser

public class ObjectClassDescriptionSchemaParser
extends AbstractSchemaParser

A parser for RFC 4512 object class descriptons

Version:
$Rev$, $Date$
Author:
Apache Directory Project

Field Summary
 
Fields inherited from class org.apache.directory.shared.ldap.schema.syntax.parser.AbstractSchemaParser
lexer, monitor, parser
 
Constructor Summary
ObjectClassDescriptionSchemaParser()
          Creates a schema parser instance.
 
Method Summary
 AbstractSchemaDescription parse(java.lang.String schemaDescription)
           
 ObjectClassDescription parseObjectClassDescription(java.lang.String objectClassDescription)
          Parses a object class definition according to RFC 4512:
 
Methods inherited from class org.apache.directory.shared.ldap.schema.syntax.parser.AbstractSchemaParser
isQuirksMode, 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 ObjectClassDescription parseObjectClassDescription(java.lang.String objectClassDescription)
                                                   throws java.text.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:
java.text.ParseException - if there are any recognition errors (bad syntax)

parse

public AbstractSchemaDescription parse(java.lang.String schemaDescription)
                                throws java.text.ParseException
Specified by:
parse in class AbstractSchemaParser
Throws:
java.text.ParseException


Copyright © 2003-2009 Apache Software Foundation. All Rights Reserved.