View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.ldap.model.schema.parsers;
21  
22  
23  import java.text.ParseException;
24  
25  import org.apache.directory.api.i18n.I18n;
26  import org.apache.directory.api.ldap.model.schema.NameForm;
27  
28  import antlr.RecognitionException;
29  import antlr.TokenStreamException;
30  
31  
32  /**
33   * A parser for RFC 4512 name form descriptions
34   * 
35   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
36   */
37  public class NameFormDescriptionSchemaParser extends AbstractSchemaParser<NameForm>
38  {
39  
40      /**
41       * Creates a schema parser instance.
42       */
43      public NameFormDescriptionSchemaParser()
44      {
45          super( NameForm.class, I18n.ERR_04248, I18n.ERR_04249, I18n.ERR_04250 );
46      }
47  
48  
49      /**
50       * Parses a name form description according to RFC 4512:
51       * 
52       * <pre>
53       * NameFormDescription = LPAREN WSP
54       *    numericoid                 ; object identifier
55       *    [ SP "NAME" SP qdescrs ]   ; short names (descriptors)
56       *    [ SP "DESC" SP qdstring ]  ; description
57       *    [ SP "OBSOLETE" ]          ; not active
58       *    SP "OC" SP oid             ; structural object class
59       *    SP "MUST" SP oids          ; attribute types
60       *    [ SP "MAY" SP oids ]       ; attribute types
61       *    extensions WSP RPAREN      ; extensions
62       * </pre>
63       * 
64       * @param nameFormDescription the name form description to be parsed
65       * @return the parsed NameForm bean
66       * @throws ParseException if there are any recognition errors (bad syntax)
67       */
68      public NameForm parseNameFormDescription( String nameFormDescription ) throws ParseException
69      {
70          return super.parse( nameFormDescription );
71      }
72  
73  
74      /**
75       * {@inheritDoc}
76       */
77      @Override
78      protected NameForm doParse() throws RecognitionException, TokenStreamException
79      {
80          return parser.nameFormDescription();
81      }
82  
83  }