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