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 */
020 package org.apache.directory.shared.ldap.schema.parsers;
021
022
023 import java.text.ParseException;
024
025
026 import antlr.RecognitionException;
027 import antlr.TokenStreamException;
028
029
030 /**
031 * A parser for RFC 4512 name form descriptons
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 * @version $Rev$, $Date$
035 */
036 public class NameFormDescriptionSchemaParser extends AbstractSchemaParser
037 {
038
039 /**
040 * Creates a schema parser instance.
041 */
042 public NameFormDescriptionSchemaParser()
043 {
044 }
045
046
047 /**
048 * Parses a name form description according to RFC 4512:
049 *
050 * <pre>
051 * NameFormDescription = LPAREN WSP
052 * numericoid ; object identifier
053 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
054 * [ SP "DESC" SP qdstring ] ; description
055 * [ SP "OBSOLETE" ] ; not active
056 * SP "OC" SP oid ; structural object class
057 * SP "MUST" SP oids ; attribute types
058 * [ SP "MAY" SP oids ] ; attribute types
059 * extensions WSP RPAREN ; extensions
060 * </pre>
061 *
062 * @param nameFormDescription the name form description to be parsed
063 * @return the parsed NameFormDescription bean
064 * @throws ParseException if there are any recognition errors (bad syntax)
065 */
066 public synchronized NameFormDescription parseNameFormDescription( String nameFormDescription )
067 throws ParseException
068 {
069
070 if ( nameFormDescription == null )
071 {
072 throw new ParseException( "Null", 0 );
073 }
074
075 reset( nameFormDescription ); // reset and initialize the parser / lexer pair
076
077 try
078 {
079 NameFormDescription nfd = parser.nameFormDescription();
080 return nfd;
081 }
082 catch ( RecognitionException re )
083 {
084 String msg = "Parser failure on name form description:\n\t" + nameFormDescription;
085 msg += "\nAntlr message: " + re.getMessage();
086 msg += "\nAntlr column: " + re.getColumn();
087 throw new ParseException( msg, re.getColumn() );
088 }
089 catch ( TokenStreamException tse )
090 {
091 String msg = "Parser failure on name form description:\n\t" + nameFormDescription;
092 msg += "\nAntlr message: " + tse.getMessage();
093 throw new ParseException( msg, 0 );
094 }
095
096 }
097
098
099 public AbstractSchemaDescription parse( String schemaDescription ) throws ParseException
100 {
101 return parseNameFormDescription( schemaDescription );
102 }
103
104 }