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.dsmlv2; 21 22 23 import java.io.IOException; 24 25 import org.xmlpull.v1.XmlPullParserException; 26 27 28 /** 29 * The interface which expose common behavior of a Grammar implementer. 30 * 31 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 32 */ 33 public interface Grammar 34 { 35 /** 36 * This method, when called, executes an action on the current data stored in 37 * the container. 38 * 39 * @param container the DSML container 40 * @throws XmlPullParserException when an unrecoverable error occurs 41 * @throws IOException when an IO error occurs 42 */ 43 void executeAction( Dsmlv2Container container ) throws XmlPullParserException, IOException; 44 45 46 /** 47 * Get the grammar name 48 * 49 * @return Return the grammar's name 50 */ 51 String getName(); 52 53 54 /** 55 * Get the statesEnum for the current grammar 56 * 57 * @return The specific States Enum for the current grammar 58 */ 59 Enum<Dsmlv2StatesEnum>[] getStatesEnum(); 60 61 62 /** 63 * Set the grammar's name 64 * 65 * @param name The grammar name 66 */ 67 void setName( String name ); 68 }