001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 * 019 */ 020package org.apache.directory.api.ldap.model.schema.parsers; 021 022 023import java.text.ParseException; 024 025import org.apache.directory.api.i18n.I18n; 026import org.apache.directory.api.ldap.model.schema.MatchingRule; 027 028import antlr.RecognitionException; 029import antlr.TokenStreamException; 030 031 032/** 033 * A parser for RFC 4512 matching rule descriptions. 034 * 035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 036 */ 037public class MatchingRuleDescriptionSchemaParser extends AbstractSchemaParser<MatchingRule> 038{ 039 /** 040 * Creates a schema parser instance. 041 */ 042 public MatchingRuleDescriptionSchemaParser() 043 { 044 super( MatchingRule.class, I18n.ERR_04242, I18n.ERR_04243, I18n.ERR_04244 ); 045 } 046 047 048 /** 049 * Parses a matching rule description according to RFC 4512: 050 * 051 * <pre> 052 * MatchingRuleDescription = LPAREN WSP 053 * numericoid ; object identifier 054 * [ SP "NAME" SP qdescrs ] ; short names (descriptors) 055 * [ SP "DESC" SP qdstring ] ; description 056 * [ SP "OBSOLETE" ] ; not active 057 * SP "SYNTAX" SP numericoid ; assertion syntax 058 * extensions WSP RPAREN ; extensions 059 * 060 * extensions = *( SP xstring SP qdstrings ) 061 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 062 * </pre> 063 * 064 * @param matchingRuleDescription the matching rule description to be parsed 065 * @return the parsed MatchingRuleDescription bean 066 * @throws ParseException if there are any recognition errors (bad syntax) 067 */ 068 public MatchingRule parseMatchingRuleDescription( String matchingRuleDescription ) throws ParseException 069 { 070 return super.parse( matchingRuleDescription ); 071 } 072 073 074 /** 075 * {@inheritDoc} 076 */ 077 @Override 078 protected MatchingRule doParse() throws RecognitionException, TokenStreamException 079 { 080 return parser.matchingRuleDescription(); 081 } 082 083}