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.MatchingRuleUse; 027 028import antlr.RecognitionException; 029import antlr.TokenStreamException; 030 031 032/** 033 * A parser for RFC 4512 matching rule use descriptions. 034 * 035 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 036 */ 037public class MatchingRuleUseDescriptionSchemaParser extends AbstractSchemaParser<MatchingRuleUse> 038{ 039 040 /** 041 * Creates a schema parser instance. 042 */ 043 public MatchingRuleUseDescriptionSchemaParser() 044 { 045 super( MatchingRuleUse.class, I18n.ERR_04245, I18n.ERR_04246, I18n.ERR_04247 ); 046 } 047 048 049 /** 050 * Parses a matching rule use description according to RFC 4512: 051 * 052 * <pre> 053 * MatchingRuleUseDescription = LPAREN WSP 054 * numericoid ; object identifier 055 * [ SP "NAME" SP qdescrs ] ; short names (descriptors) 056 * [ SP "DESC" SP qdstring ] ; description 057 * [ SP "OBSOLETE" ] ; not active 058 * SP "APPLIES" SP oids ; attribute types 059 * extensions WSP RPAREN ; extensions 060 * 061 * extensions = *( SP xstring SP qdstrings ) 062 * xstring = "X" HYPHEN 1*( ALPHA / HYPHEN / USCORE ) 063 * </pre> 064 * 065 * @param matchingRuleUseDescription the matching rule use description to be parsed 066 * @return the parsed MatchingRuleUseDescription bean 067 * @throws ParseException if there are any recognition errors (bad syntax) 068 */ 069 public MatchingRuleUse parseMatchingRuleUseDescription( String matchingRuleUseDescription ) throws ParseException 070 { 071 return super.parse( matchingRuleUseDescription ); 072 } 073 074 075 /** 076 * {@inheritDoc} 077 */ 078 @Override 079 protected MatchingRuleUse doParse() throws RecognitionException, TokenStreamException 080 { 081 return parser.matchingRuleUseDescription(); 082 } 083 084}