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.DitStructureRule; 27 28 import antlr.RecognitionException; 29 import antlr.TokenStreamException; 30 31 32 /** 33 * A parser for RFC 4512 DIT structure rule descriptions. 34 * 35 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 36 */ 37 public class DitStructureRuleDescriptionSchemaParser extends AbstractSchemaParser<DitStructureRule> 38 { 39 40 /** 41 * Creates a schema parser instance. 42 */ 43 public DitStructureRuleDescriptionSchemaParser() 44 { 45 super( DitStructureRule.class, I18n.ERR_04233, I18n.ERR_04234, I18n.ERR_04235 ); 46 } 47 48 49 /** 50 * Parses a DIT structure rule description according to RFC 4512: 51 * 52 * <pre> 53 * DITStructureRuleDescription = LPAREN WSP 54 * ruleid ; rule identifier 55 * [ SP "NAME" SP qdescrs ] ; short names (descriptors) 56 * [ SP "DESC" SP qdstring ] ; description 57 * [ SP "OBSOLETE" ] ; not active 58 * SP "FORM" SP oid ; NameForm 59 * [ SP "SUP" ruleids ] ; superior rules 60 * extensions WSP RPAREN ; extensions 61 * 62 * ruleids = ruleid / ( LPAREN WSP ruleidlist WSP RPAREN ) 63 * ruleidlist = ruleid *( SP ruleid ) 64 * ruleid = numbers 65 * </pre> 66 * 67 * @param ditStructureRuleDescription the DIT structure rule description to be parsed 68 * @return the parsed DITStructureRuleDescription bean 69 * @throws ParseException if there are any recognition errors (bad syntax) 70 */ 71 public DitStructureRule parseDITStructureRuleDescription( String ditStructureRuleDescription ) 72 throws ParseException 73 { 74 return super.parse( ditStructureRuleDescription ); 75 76 } 77 78 79 /** 80 * {@inheritDoc} 81 */ 82 @Override 83 protected DitStructureRule doParse() throws RecognitionException, TokenStreamException 84 { 85 return parser.ditStructureRuleDescription(); 86 } 87 }