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  package org.apache.directory.api.ldap.codec.controls.sort;
21  
22  
23  import org.apache.directory.api.asn1.ber.AbstractContainer;
24  import org.apache.directory.api.ldap.codec.api.ControlContainer;
25  import org.apache.directory.api.ldap.model.message.Control;
26  import org.apache.directory.api.ldap.model.message.controls.SortKey;
27  import org.apache.directory.api.ldap.model.message.controls.SortRequest;
28  
29  
30  /**
31   * Container for SortRequestControl.
32   *
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   */
35  public class SortRequestContainer extends AbstractContainer implements ControlContainer
36  {
37      /** the sort request control decorator */
38      private Control control;
39  
40      /** current key that is being decoded */
41      private SortKey currentKey;
42  
43      /**
44       * Creates a new instance of SortRequestContainer.
45       *
46       * @param control the sort request control
47       */
48      public SortRequestContainer( Control control )
49      {
50          super();
51          setGrammar( SortRequestGrammar.getInstance() );
52          setTransition( SortRequestStates.START_STATE );
53          this.control = control;
54      }
55  
56  
57      /**
58       * @return the control
59       */
60      public SortRequest getControl()
61      {
62          return ( SortRequest ) control;
63      }
64  
65  
66      /**
67       * @param control the control to set
68       */
69      public void setControl( Control
70          control )
71      {
72          this.control = control;
73      }
74  
75  
76      /**
77       * Clean the container
78       */
79      @Override
80      public void clean()
81      {
82          super.clean();
83          control = null;
84      }
85  
86  
87      /**
88       * @return the currentKey
89       */
90      public SortKey getCurrentKey()
91      {
92          return currentKey;
93      }
94  
95  
96      /**
97       * @param currentKey the currentKey to set
98       */
99      public void setCurrentKey( SortKey currentKey )
100     {
101         this.currentKey = currentKey;
102     }
103 }