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

Class NameFormDescriptionSchemaParser

java.lang.Object

org.apache.directory.shared.ldap.schema.parsers.AbstractSchemaParser

org.apache.directory.shared.ldap.schema.parsers.NameFormDescriptionSchemaParser

public class NameFormDescriptionSchemaParser
extends AbstractSchemaParser

A parser for RFC 4512 name form descriptions

Version:

$Rev$, $Date$

Author:

Apache Directory Project

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

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

Method Summary

Modifier and Type	Method and Description
NameForm	parse(String schemaDescription) Parses a NameForm description
NameForm	parseNameFormDescription(String nameFormDescription) Parses a name form description 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

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)

parse

public NameForm parse(String schemaDescription)
               throws ParseException

Parses a NameForm description

Specified by:

parse in class AbstractSchemaParser

Parameters:

The - NameForm description to parse

Returns:

An instance of NameForm

Throws:

ParseException - If the parsing failed