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 *    https://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 */
020package org.apache.directory.api.ldap.extras.controls.syncrepl_impl;
021
022
023import org.apache.directory.api.asn1.ber.AbstractContainer;
024import org.apache.directory.api.ldap.codec.api.ControlContainer;
025import org.apache.directory.api.ldap.extras.controls.syncrepl.syncDone.SyncDoneValue;
026import org.apache.directory.api.ldap.model.message.Control;
027
028
029/**
030 * 
031 * ASN.1 container for SyncDoneValueControl.
032 *
033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
034 */
035public class SyncDoneValueContainer extends AbstractContainer implements ControlContainer
036{
037    /** syncDoneValue*/
038    private Control control;
039
040    /**
041     * Creates a new SyncDoneValueControlContainer object.
042     *
043     * @param control The control to store
044     */
045    public SyncDoneValueContainer( Control control )
046    {
047        super();
048        this.control = control;
049        setGrammar( SyncDoneValueGrammar.getInstance() );
050        setTransition( SyncDoneValueStatesEnum.START_STATE );
051    }
052
053
054    /**
055     * @return the SyncDoneValueControlCodec object
056     */
057    public SyncDoneValue getSyncDoneValue()
058    {
059        return ( SyncDoneValue ) control;
060    }
061
062
063    /**
064     * Set a SyncDoneValueControlCodec Object into the container. It will be completed
065     * by the ldapDecoder.
066     * 
067     * @param control the SyncDoneValueControlCodec to set.
068     */
069    public void setControl( Control control )
070    {
071        this.control = control;
072    }
073
074
075    /**
076     * clean the container
077     */
078    @Override
079    public void clean()
080    {
081        super.clean();
082        control = null;
083    }
084}