View Javadoc
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.extras.controls.syncrepl_impl;
21  
22  
23  import org.apache.directory.api.asn1.ber.grammar.Grammar;
24  import org.apache.directory.api.asn1.ber.grammar.States;
25  
26  
27  /**
28   * ASN.1 grammer constants of SyncDoneValueControl.
29   * 
30   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
31   */
32  public enum SyncDoneValueStatesEnum implements States
33  {
34  
35      /** The END_STATE */
36      END_STATE,
37  
38      /***/
39      START_STATE,
40  
41      /** sequence start state */
42      SYNC_DONE_VALUE_SEQUENCE_STATE,
43  
44      /** cookie value state */
45      COOKIE_STATE,
46  
47      /** refreshDeletes value state */
48      REFRESH_DELETES_STATE,
49  
50      /** terminal state */
51      LAST_SYNC_DONE_VALUE_STATE;
52  
53      /**
54       * Get the grammar name
55       * 
56       * @param grammar The grammar code
57       * @return The grammar name
58       */
59      public String getGrammarName( int grammar )
60      {
61          return "SYNC_DONE_VALUE_GRAMMAR";
62      }
63  
64  
65      /**
66       * Get the grammar name
67       * 
68       * @param grammar The grammar class
69       * @return The grammar name
70       */
71      public String getGrammarName( Grammar<SyncDoneValueContainer> grammar )
72      {
73          if ( grammar instanceof SyncDoneValueGrammar )
74          {
75              return "SYNC_DONE_VALUE_GRAMMAR";
76          }
77  
78          return "UNKNOWN GRAMMAR";
79      }
80  
81  
82      /**
83       * Get the string representing the state
84       * 
85       * @param state The state number
86       * @return The String representing the state
87       */
88      public String getState( int state )
89      {
90          return ( ( state == END_STATE.ordinal() ) ? "SYNC_DONE_VALUE_GRAMMAR" : this.name() );
91      }
92  
93  
94      /**
95       * {@inheritDoc}
96       */
97      public boolean isEndState()
98      {
99          return this == END_STATE;
100     }
101 
102 
103     /**
104      * {@inheritDoc}
105      */
106     public SyncDoneValueStatesEnum getStartState()
107     {
108         return START_STATE;
109     }
110 }