001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 * 
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 * 
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 * 
019 */
020package org.apache.directory.api.ldap.model.schema.parsers;
021
022
023import java.text.ParseException;
024
025import org.apache.directory.api.i18n.I18n;
026import org.apache.directory.api.ldap.model.schema.LdapSyntax;
027
028import antlr.RecognitionException;
029import antlr.TokenStreamException;
030
031
032/**
033 * A parser for RFC 4512 LDAP syntx descriptions.
034 * 
035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
036 */
037public class LdapSyntaxDescriptionSchemaParser extends AbstractSchemaParser<LdapSyntax>
038{
039
040    /**
041     * Creates a schema parser instance.
042     */
043    public LdapSyntaxDescriptionSchemaParser()
044    {
045        super( LdapSyntax.class, I18n.ERR_04239, I18n.ERR_04240, I18n.ERR_04241 );
046    }
047
048
049    /**
050     * Parses a LDAP syntax description according to RFC 4512:
051     * 
052     * <pre>
053     * SyntaxDescription = LPAREN WSP
054     *    numericoid                 ; object identifier
055     *    [ SP "DESC" SP qdstring ]  ; description
056     *    extensions WSP RPAREN      ; extensions
057     * </pre>
058     * 
059     * @param ldapSyntaxDescription the LDAP syntax description to be parsed
060     * @return the parsed LdapSyntax bean
061     * @throws ParseException if there are any recognition errors (bad syntax)
062     */
063    public LdapSyntax parseLdapSyntaxDescription( String ldapSyntaxDescription ) throws ParseException
064    {
065        return super.parse( ldapSyntaxDescription );
066    }
067
068
069    /**
070     * {@inheritDoc}
071     */
072    @Override
073    protected LdapSyntax doParse() throws RecognitionException, TokenStreamException
074    {
075        return parser.ldapSyntaxDescription();
076    }
077
078}