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.ObjectClass;
027
028import antlr.RecognitionException;
029import antlr.TokenStreamException;
030
031
032/**
033 * A parser for RFC 4512 object class descriptons
034 * 
035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
036 */
037public class ObjectClassDescriptionSchemaParser extends AbstractSchemaParser<ObjectClass>
038{
039
040    /**
041     * Creates a schema parser instance.
042     */
043    public ObjectClassDescriptionSchemaParser()
044    {
045        super( ObjectClass.class, I18n.ERR_04254, I18n.ERR_04255, I18n.ERR_04256 );
046    }
047
048
049    /**
050     * Parses a object class definition according to RFC 4512:
051     * 
052     * <pre>
053     * ObjectClassDescription = LPAREN WSP
054     *     numericoid                 ; object identifier
055     *     [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
056     *     [ SP "DESC" SP qdstring ]  ; description
057     *     [ SP "OBSOLETE" ]          ; not active
058     *     [ SP "SUP" SP oids ]       ; superior object classes
059     *     [ SP kind ]                ; kind of class
060     *     [ SP "MUST" SP oids ]      ; attribute types
061     *     [ SP "MAY" SP oids ]       ; attribute types
062     *     extensions WSP RPAREN
063     *
064     * kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
065     * 
066     * extensions = *( SP xstring SP qdstrings )
067     * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
068     * </pre>
069     * 
070     * @param objectClassDescription the object class description to be parsed
071     * @return the parsed ObjectClassDescription bean
072     * @throws ParseException if there are any recognition errors (bad syntax)
073     */
074    public ObjectClass parseObjectClassDescription( String objectClassDescription ) throws ParseException
075    {
076        return super.parse( objectClassDescription );
077    }
078
079
080    /**
081     * {@inheritDoc}
082     */
083    @Override
084    protected ObjectClass doParse() throws RecognitionException, TokenStreamException
085    {
086        return parser.objectClassDescription();
087    }
088
089}