001    /*
002     *  Licensed to the Apache Software Foundation (ASF) under one
003     *  or more contributor license agreements.  See the NOTICE file
004     *  distributed with this work for additional information
005     *  regarding copyright ownership.  The ASF licenses this file
006     *  to you under the Apache License, Version 2.0 (the
007     *  "License"); you may not use this file except in compliance
008     *  with the License.  You may obtain a copy of the License at
009     *  
010     *    http://www.apache.org/licenses/LICENSE-2.0
011     *  
012     *  Unless required by applicable law or agreed to in writing,
013     *  software distributed under the License is distributed on an
014     *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     *  KIND, either express or implied.  See the License for the
016     *  specific language governing permissions and limitations
017     *  under the License. 
018     *  
019     */
020    package org.apache.directory.shared.ldap.codec.search.controls.pagedSearch;
021    
022    
023    import org.apache.directory.shared.asn1.ber.AbstractContainer;
024    
025    
026    /**
027     * A container for the Paged Search Control.
028     * 
029     * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030     * @version $Rev: 664290 $, $Date: 2008-06-07 08:28:06 +0200 (Sat, 07 Jun 2008) $, 
031     */
032    public class PagedSearchControlContainer extends AbstractContainer
033    {
034        /** PagedSearchControl */
035        private PagedSearchControlCodec control;
036    
037    
038        /**
039         * Creates a new PagedSearchControl container object. We will store one grammar,
040         * it's enough ...
041         */
042        public PagedSearchControlContainer()
043        {
044            super();
045            stateStack = new int[1];
046            grammar = PagedSearchControlGrammar.getInstance();
047            states = PagedSearchControlStatesEnum.getInstance();
048        }
049    
050    
051        /**
052         * @return Returns the paged search control.
053         */
054        public PagedSearchControlCodec getPagedSearchControl()
055        {
056    
057            return control;
058        }
059    
060    
061        /**
062         * Set a PagedSearchControl Object into the container. It will be completed by
063         * the ldapDecoder.
064         * 
065         * @param control the PagedSearchControl to set.
066         */
067        public void setPagedSearchControl( PagedSearchControlCodec control )
068        {
069            this.control = control;
070        }
071    
072        /**
073         * Clean the container
074         */
075        public void clean()
076        {
077            super.clean();
078            control = null;
079        }
080    }