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 */
020package org.apache.directory.ldap.client.api.future;
021
022
023import java.util.concurrent.ExecutionException;
024import java.util.concurrent.TimeUnit;
025import java.util.concurrent.TimeoutException;
026
027import org.apache.directory.api.ldap.model.message.DeleteResponse;
028import org.apache.directory.ldap.client.api.LdapConnection;
029
030
031/**
032 * A Future to manage DeleteRequests.
033 *
034 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
035 */
036public class DeleteFuture extends ResponseFuture<DeleteResponse>
037{
038    /**
039     * Creates a new instance of DeleteFuture.
040     *
041     * @param connection the LDAP connection
042     * @param messageId The associated messageId
043     */
044    public DeleteFuture( LdapConnection connection, int messageId )
045    {
046        super( connection, messageId );
047    }
048
049
050    /**
051     * Get the DeleteResponse, blocking until one is received, or until the
052     * given timeout is reached.
053     * 
054     * @param timeout {@inheritDoc}
055     * @param unit {@inheritDoc}
056     * @return the delete response
057     * @throws InterruptedException {@inheritDoc}
058     * @throws ExecutionException {@inheritDoc}
059     * @throws TimeoutException {@inheritDoc}
060     */
061    public DeleteResponse get( long timeout, TimeUnit unit ) throws InterruptedException, ExecutionException,
062        TimeoutException
063    {
064        return super.get( timeout, unit );
065    }
066
067
068    /**
069     * {@inheritDoc}
070     */
071    public String toString()
072    {
073        StringBuilder sb = new StringBuilder();
074
075        sb.append( "DeleteFuture" ).append( super.toString() );
076
077        return sb.toString();
078    }
079}