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 27 import antlr.RecognitionException; 28 import antlr.TokenStreamException; 29 30 31 /** 32 * A parser for ApacheDS comparator descriptions. 33 * 34 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 35 */ 36 public class LdapComparatorDescriptionSchemaParser extends AbstractSchemaParser<LdapComparatorDescription> 37 { 38 39 /** 40 * Creates a schema parser instance. 41 */ 42 public LdapComparatorDescriptionSchemaParser() 43 { 44 super( LdapComparatorDescription.class, I18n.ERR_04236, I18n.ERR_04237, I18n.ERR_04238 ); 45 } 46 47 48 /** 49 * Parses an comparator description: 50 * 51 * <pre> 52 * ComparatorDescription = LPAREN WSP 53 * numericoid ; object identifier 54 * [ SP "DESC" SP qdstring ] ; description 55 * SP "FQCN" SP fqcn ; fully qualified class name 56 * [ SP "BYTECODE" SP base64 ] ; optional base64 encoded bytecode 57 * extensions WSP RPAREN ; extensions 58 * 59 * base64 = *(4base64-char) 60 * base64-char = ALPHA / DIGIT / "+" / "/" 61 * fqcn = fqcnComponent 1*( DOT fqcnComponent ) 62 * fqcnComponent = ??? 63 * 64 * extensions = *( SP xstring SP qdstrings ) 65 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 66 * </pre> 67 * 68 * @param comparatorDescription the comparator description to be parsed 69 * @return the parsed ComparatorDescription bean 70 * @throws ParseException if there are any recognition errors (bad syntax) 71 */ 72 public LdapComparatorDescription parseComparatorDescription( String comparatorDescription ) throws ParseException 73 { 74 return super.parse( comparatorDescription ); 75 } 76 77 78 /** 79 * {@inheritDoc} 80 */ 81 @Override 82 protected LdapComparatorDescription doParse() throws RecognitionException, TokenStreamException 83 { 84 return parser.ldapComparator(); 85 } 86 87 }