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.MatchingRuleUse;
27
28 import antlr.RecognitionException;
29 import antlr.TokenStreamException;
30
31
32 /**
33 * A parser for RFC 4512 matching rule use descriptions.
34 *
35 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
36 */
37 public class MatchingRuleUseDescriptionSchemaParser extends AbstractSchemaParser<MatchingRuleUse>
38 {
39
40 /**
41 * Creates a schema parser instance.
42 */
43 public MatchingRuleUseDescriptionSchemaParser()
44 {
45 super( MatchingRuleUse.class, I18n.ERR_04245, I18n.ERR_04246, I18n.ERR_04247 );
46 }
47
48
49 /**
50 * Parses a matching rule use description according to RFC 4512:
51 *
52 * <pre>
53 * MatchingRuleUseDescription = 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 "APPLIES" SP oids ; attribute types
59 * extensions WSP RPAREN ; extensions
60 *
61 * extensions = *( SP xstring SP qdstrings )
62 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE )
63 * </pre>
64 *
65 * @param matchingRuleUseDescription the matching rule use description to be parsed
66 * @return the parsed MatchingRuleUseDescription bean
67 * @throws ParseException if there are any recognition errors (bad syntax)
68 */
69 public MatchingRuleUse parseMatchingRuleUseDescription( String matchingRuleUseDescription ) throws ParseException
70 {
71 return super.parse( matchingRuleUseDescription );
72 }
73
74
75 /**
76 * {@inheritDoc}
77 */
78 @Override
79 protected MatchingRuleUse doParse() throws RecognitionException, TokenStreamException
80 {
81 return parser.matchingRuleUseDescription();
82 }
83
84 }