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 /**
24 * This interface represents a container that can be used by the parser to store parsed information
25 *
26 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
27 */
28 public interface Container
29 {
30 /**
31 * Gets the current grammar state
32 *
33 * @return Returns the current grammar state
34 */
35 Enum<Dsmlv2StatesEnum> getState();
36
37
38 /**
39 * Sets the new current state
40 *
41 * @param state The new state
42 */
43 void setState( Enum<Dsmlv2StatesEnum> state );
44
45
46 /**
47 * Gets the transition
48 *
49 * @return Returns the transition from the previous state to the new state
50 */
51 Enum<Dsmlv2StatesEnum> getTransition();
52
53
54 /**
55 * Updates the transition from a state to another
56 *
57 * @param transition The transition to set
58 */
59 void setTransition( Enum<Dsmlv2StatesEnum> transition );
60
61
62 /**
63 * @return Returns the states.
64 */
65 Enum<Dsmlv2StatesEnum>[] getStates();
66 }