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

Class LdapComparatorDescriptionSchemaParser

java.lang.Object

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

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

public class LdapComparatorDescriptionSchemaParser
extends AbstractSchemaParser<LdapComparatorDescription>

A parser for ApacheDS comparator descriptions.

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

Method Summary

Modifier and Type	Method and Description
protected LdapComparatorDescription	doParse() Parse a SchemaObject description and returns back an instance of SchemaObject.
LdapComparatorDescription	parseComparatorDescription(String comparatorDescription) Parses an comparator description:

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

LdapComparatorDescriptionSchemaParser

public LdapComparatorDescriptionSchemaParser()

Creates a schema parser instance.

Method Detail

parseComparatorDescription

public LdapComparatorDescription parseComparatorDescription(String comparatorDescription)
                                                     throws ParseException

Parses an comparator description:

 ComparatorDescription = LPAREN WSP
     numericoid                           ; object identifier
     [ SP "DESC" SP qdstring ]            ; description
     SP "FQCN" SP fqcn                    ; fully qualified class name
     [ SP "BYTECODE" SP base64 ]          ; optional base64 encoded bytecode
     extensions WSP RPAREN                ; extensions
 
 base64          = *(4base64-char)
 base64-char     = ALPHA / DIGIT / "+" / "/"
 fqcn = fqcnComponent 1*( DOT fqcnComponent )
 fqcnComponent = ???
 
 extensions = *( SP xstring SP qdstrings )
 xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 
 

Parameters:

comparatorDescription - the comparator description to be parsed

Returns:

the parsed ComparatorDescription bean

Throws:

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

doParse

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

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

Specified by:

doParse in class AbstractSchemaParser<LdapComparatorDescription>

Returns:

A SchemaObject instance

Throws:

antlr.RecognitionException - the native antlr exception

antlr.TokenStreamException - the native antlr exception