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

Class AttributeTypeDescriptionSchemaParser

java.lang.Object

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

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

public class AttributeTypeDescriptionSchemaParser
extends AbstractSchemaParser<AttributeType>

A parser for RFC 4512 attribute type descriptions.

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor	Description
AttributeTypeDescriptionSchemaParser()	Creates a schema parser instance.

Method Summary

Modifier and Type	Method	Description
AttributeType	parse(String attributeTypeDescription)	Parses a attribute type description according to RFC 4512:

Methods inherited from class org.apache.directory.api.ldap.model.schema.parsers.AbstractSchemaParser

getObjectIdentifiers, isQuirksMode, setQuirksMode

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AttributeTypeDescriptionSchemaParser

public AttributeTypeDescriptionSchemaParser()

Creates a schema parser instance.

Method Detail

parse

public AttributeType parse(String attributeTypeDescription)
                    throws ParseException

Parses a attribute type description according to RFC 4512:

 AttributeTypeDescription = LPAREN WSP
     numericoid                    ; object identifier
     [ SP "NAME" SP qdescrs ]      ; short names (descriptors)
     [ SP "DESC" SP qdstring ]     ; description
     [ SP "OBSOLETE" ]             ; not active
     [ SP "SUP" SP oid ]           ; supertype
     [ SP "EQUALITY" SP oid ]      ; equality matching rule
     [ SP "ORDERING" SP oid ]      ; ordering matching rule
     [ SP "SUBSTR" SP oid ]        ; substrings matching rule
     [ SP "SYNTAX" SP noidlen ]    ; value syntax
     [ SP "SINGLE-VALUE" ]         ; single-value
     [ SP "COLLECTIVE" ]           ; collective
     [ SP "NO-USER-MODIFICATION" ] ; not user modifiable
     [ SP "USAGE" SP usage ]       ; usage
     extensions WSP RPAREN         ; extensions
 
 usage = "userApplications"     /  ; user
         "directoryOperation"   /  ; directory operational
         "distributedOperation" /  ; DSA-shared operational
         "dSAOperation"            ; DSA-specific operational     
 
 extensions = *( SP xstring SP qdstrings )
 xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 
 

Specified by:

parse in class AbstractSchemaParser<AttributeType>

Parameters:

attributeTypeDescription - the attribute type description to be parsed

Returns:

the parsed AttributeTypeDescription bean

Throws:

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