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   *     https://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  
21  package org.apache.directory.api.ldap.extras.controls.vlv_impl;
22  
23  
24  import org.apache.directory.api.asn1.ber.grammar.States;
25  
26  
27  /**
28   * This class store the VirtualListViewRequest grammar constants. It is also used for
29   * debugging purposes.
30   *
31   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32   */
33  public enum VirtualListViewRequestStates implements States
34  {
35      /** Initial state */
36      START_STATE,
37      
38      /** VirtualListViewRequest ::= SEQUENCE  transition */
39      VLV_SEQUENCE_STATE,
40      
41      /** beforeCount    INTEGER (0..maxInt) transition */
42      VLV_BEFORE_COUNT_STATE,
43      
44      /** afterCount     INTEGER (0..maxInt) transition */
45      VLV_AFTER_COUNT_STATE,
46      
47      /** byOffset        [0] SEQUENCE transition */
48      VLV_TARGET_BY_OFFSET_STATE,
49      
50      /** offset          INTEGER (1 .. maxInt) transition */
51      VLV_OFFSET_STATE,
52      
53      /** contentCount    INTEGER (0 .. maxInt) transition */
54      VLV_CONTENT_COUNT_STATE,
55      
56      /** contextID     OCTET STRING OPTIONAL transition */
57      VLV_CONTEXT_ID_STATE,
58      
59      /** greaterThanOrEqual [1] AssertionValue  transition */
60      VLV_ASSERTION_VALUE_STATE,
61      
62      /** Final state */
63      END_STATE;
64  
65      /**
66       * Get the grammar name
67       * 
68       * @return The grammar name
69       */
70      public String getGrammarName()
71      {
72          return "VLV_REQUEST_GRAMMAR";
73      }
74  
75  
76      /**
77       * Get the string representing the state
78       * 
79       * @param state The state number
80       * @return The String representing the state
81       */
82      public String getState( int state )
83      {
84          return ( state == END_STATE.ordinal() ) ? "VLV_REQUEST_END_STATE" : name();
85      }
86  
87  
88      /**
89       * {@inheritDoc}
90       */
91      @Override
92      public boolean isEndState()
93      {
94          return this == END_STATE;
95      }
96  
97  
98      /**
99       * {@inheritDoc}
100      */
101     @Override
102     public Enum<?> getStartState()
103     {
104         return START_STATE;
105     }
106 }