org.apache.directory.shared.ldap.schema.parsers
Class ObjectClassDescriptionSchemaParser

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

public class ObjectClassDescriptionSchemaParser
extends AbstractSchemaParser

A parser for RFC 4512 object class descriptons

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

Field Summary
protected static org.slf4j.Logger LOG
          The LoggerFactory used by this class
 
Fields inherited from class org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser
lexer, monitor, parser
 
Constructor Summary
ObjectClassDescriptionSchemaParser()
          Creates a schema parser instance.
 
Method Summary
 ObjectClass parse(java.lang.String schemaDescription)
          Parse a SchemaObject description and returns back an instance of SchemaObject.
 ObjectClass parseObjectClassDescription(java.lang.String objectClassDescription)
          Parses a object class definition according to RFC 4512:
 
Methods inherited from class org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser
isQuirksMode, reset, setParserMonitor, setQuirksMode, setSchemaName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

LOG

protected static final org.slf4j.Logger LOG
The LoggerFactory used by this class

Constructor Detail

ObjectClassDescriptionSchemaParser

public ObjectClassDescriptionSchemaParser()
Creates a schema parser instance.

Method Detail

parseObjectClassDescription

public ObjectClass 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 ObjectClass parse(java.lang.String schemaDescription)
                  throws java.text.ParseException
Description copied from class: AbstractSchemaParser
Parse a SchemaObject description and returns back an instance of SchemaObject.

Specified by:
parse in class AbstractSchemaParser
Parameters:
schemaDescription - The SchemaObject description
Returns:
A SchemaObject instance
Throws:
java.text.ParseException - If the parsing failed


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