org.apache.directory.api.ldap.model.subtree

Class SubtreeSpecificationParser

java.lang.Object

org.apache.directory.api.ldap.model.subtree.SubtreeSpecificationParser

public class SubtreeSpecificationParser
extends Object

A reusable wrapper around the antlr generated parser for an LDAP subtree specification as defined by RFC 3672. This class enables the reuse of the antlr parser/lexer pair without having to recreate the pair every time.

Author:

Apache Directory Project

See Also:

RFC 3672

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	isNormalizing
private ReusableAntlrSubtreeSpecificationLexer	lexer the antlr generated lexer being wrapped
private ReusableAntlrSubtreeSpecificationParser	parser the antlr generated parser being wrapped

Constructor Summary

Constructors

Constructor and Description
SubtreeSpecificationParser(NormalizerMappingResolver resolver, SchemaManager schemaManager) Creates a normalizing subtree specification parser.
SubtreeSpecificationParser(SchemaManager schemaManager) Creates a subtree specification parser.

Method Summary

Modifier and Type	Method and Description
boolean	isNormizing() Tests to see if this parser is normalizing.
SubtreeSpecification	parse(String spec) Parses a subtree specification without exhausting the parser.
private void	reset(String spec) Initializes the plumbing by creating a pipe and coupling the parser/lexer pair with it.

Methods inherited from class java.lang.Object

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

Field Detail

parser

private ReusableAntlrSubtreeSpecificationParser parser

the antlr generated parser being wrapped

lexer

private ReusableAntlrSubtreeSpecificationLexer lexer

the antlr generated lexer being wrapped

isNormalizing

private final boolean isNormalizing

Constructor Detail

SubtreeSpecificationParser

public SubtreeSpecificationParser(SchemaManager schemaManager)

Creates a subtree specification parser.

Parameters:

schemaManager - The SchemaManager

SubtreeSpecificationParser

public SubtreeSpecificationParser(NormalizerMappingResolver resolver,
                                  SchemaManager schemaManager)

Creates a normalizing subtree specification parser.

Parameters:

resolver - The resolver to use

schemaManager - The SchemaManager

Method Detail

reset

private void reset(String spec)

Initializes the plumbing by creating a pipe and coupling the parser/lexer pair with it.

Parameters:

spec - The specification to parse

parse

public SubtreeSpecification parse(String spec)
                           throws ParseException

Parses a subtree specification without exhausting the parser.

Parameters:

spec - the specification to be parsed

Returns:

the specification bean

Throws:

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

isNormizing

public boolean isNormizing()

Tests to see if this parser is normalizing.

Returns:

true if it normalizes false otherwise