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.MutableObjectClass;
27 import org.apache.directory.api.ldap.model.schema.ObjectClass;
28
29 import antlr.RecognitionException;
30 import antlr.TokenStreamException;
31
32
33 /**
34 * A parser for RFC 4512 object class descriptons
35 *
36 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
37 */
38 public class ObjectClassDescriptionSchemaParser extends AbstractSchemaParser<ObjectClass>
39 {
40
41 /**
42 * Creates a schema parser instance.
43 */
44 public ObjectClassDescriptionSchemaParser()
45 {
46 super( ObjectClass.class, I18n.ERR_04254, I18n.ERR_04255, I18n.ERR_04256 );
47 }
48
49
50 /**
51 * Parses a object class definition according to RFC 4512:
52 *
53 * <pre>
54 * ObjectClassDescription = LPAREN WSP
55 * numericoid ; object identifier
56 * [ SP "NAME" SP qdescrs ] ; short names (descriptors)
57 * [ SP "DESC" SP qdstring ] ; description
58 * [ SP "OBSOLETE" ] ; not active
59 * [ SP "SUP" SP oids ] ; superior object classes
60 * [ SP kind ] ; kind of class
61 * [ SP "MUST" SP oids ] ; attribute types
62 * [ SP "MAY" SP oids ] ; attribute types
63 * extensions WSP RPAREN
64 *
65 * kind = "ABSTRACT" / "STRUCTURAL" / "AUXILIARY"
66 *
67 * extensions = *( SP xstring SP qdstrings )
68 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
69 * </pre>
70 *
71 * @param objectClassDescription the object class description to be parsed
72 * @return the parsed ObjectClassDescription bean
73 * @throws ParseException if there are any recognition errors (bad syntax)
74 */
75 public ObjectClass parseObjectClassDescription( String objectClassDescription ) throws ParseException
76 {
77 return super.parse( objectClassDescription );
78 }
79
80
81 /**
82 * {@inheritDoc}
83 */
84 @Override
85 protected ObjectClass doParse() throws RecognitionException, TokenStreamException
86 {
87 return parser.objectClassDescription();
88 }
89
90 }