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
028
029/**
030 * A parser for RFC 4512 LDAP syntx descriptions.
031 * 
032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033 */
034public class LdapSyntaxDescriptionSchemaParser extends AbstractSchemaParser<LdapSyntax>
035{
036
037    /**
038     * Creates a schema parser instance.
039     */
040    public LdapSyntaxDescriptionSchemaParser()
041    {
042        super( LdapSyntax.class, I18n.ERR_13842_CANNOT_PARSE_NULL_SYNTAX, I18n.ERR_13843_SYNTAX_PARSING_FAILURE, 
043            I18n.ERR_13844_SYNTAX_DESC_PARSING_FAILURE );
044    }
045
046
047    /**
048     * Parses a LDAP syntax description according to RFC 4512:
049     * 
050     * <pre>
051     * SyntaxDescription = LPAREN WSP
052     *    numericoid                 ; object identifier
053     *    [ SP "DESC" SP qdstring ]  ; description
054     *    extensions WSP RPAREN      ; extensions
055     * </pre>
056     * 
057     * @param ldapSyntaxDescription the LDAP syntax description to be parsed
058     * @return the parsed LdapSyntax bean
059     * @throws ParseException if there are any recognition errors (bad syntax)
060     */
061    public LdapSyntax parse( String ldapSyntaxDescription ) throws ParseException
062    {
063        LdapSyntax ldapSyntax = fastParser.parseLdapSyntax( ldapSyntaxDescription );
064        ldapSyntax.setSpecification( ldapSyntaxDescription );
065
066        // Update the schemaName
067        updateSchemaName( ldapSyntax );
068
069        return ldapSyntax;
070    }
071}