/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions Copyright [year] [name of copyright owner]".
 *
 * Copyright 2009 Sun Microsystems, Inc.
 * Portions copyright 2013-2015 ForgeRock AS.
 * Portions Copyright 2026 3A Systems, LLC.
 */
package org.opends.server.replication.plugin;

import java.util.Collection;
import java.util.Deque;
import java.util.Iterator;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.ConcurrentLinkedDeque;
import java.util.concurrent.TimeUnit;

/**
 * A very partial implementation of a Blocking queue that should be used for
 * test purpose only.
 * <p>
 * Not all the methods are implemented.
 */
public class TestSynchronousReplayQueue implements BlockingQueue<UpdateToReplay>
{
  /**
   * Written by the listener thread of the domain - a change the replication server delivers
   * is offered here - and read by the thread of the test, which replays it: the two share no
   * lock, so the deque has to be safe for that hand-off. {@code take()} is still synchronous -
   * it throws when nothing was offered - which is what makes the queue a test one.
   */
  private final Deque<UpdateToReplay> list = new ConcurrentLinkedDeque<>();

  @Override
  public boolean add(UpdateToReplay e)
  {
    return this.list.add(e);
  }

  @Override
  public boolean contains(Object o)
  {
    return this.list.contains(o);
  }

  @Override
  public int drainTo(Collection<? super UpdateToReplay> c)
  {
    return 0;
  }

  @Override
  public int drainTo(Collection<? super UpdateToReplay> c, int maxElements)
  {
    return 0;
  }

  @Override
  public boolean offer(UpdateToReplay e)
  {
    return list.add(e);
  }

  @Override
  public boolean offer(UpdateToReplay e, long timeout, TimeUnit unit)
      throws InterruptedException
  {
    return list.add(e);
  }

  @Override
  public UpdateToReplay poll(long timeout, TimeUnit unit)
      throws InterruptedException
  {
    return null;
  }

  @Override
  public void put(UpdateToReplay e) throws InterruptedException
  {
  }

  @Override
  public int remainingCapacity()
  {
    return 0;
  }

  @Override
  public boolean remove(Object o)
  {
    return this.list.remove(o);
  }

  @Override
  public UpdateToReplay take() throws InterruptedException
  {
    return list.removeFirst();
  }

  @Override
  public UpdateToReplay element()
  {
    return null;
  }

  @Override
  public UpdateToReplay peek()
  {
    return this.list.peek();
  }

  @Override
  public UpdateToReplay poll()
  {
    return this.list.poll();
  }

  @Override
  public UpdateToReplay remove()
  {
    return this.list.remove();
  }

  @Override
  public boolean addAll(Collection<? extends UpdateToReplay> c)
  {
    return this.list.addAll(c);
  }

  @Override
  public void clear()
  {
    this.list.clear();
  }

  @Override
  public boolean containsAll(Collection<?> c)
  {
    return this.list.containsAll(c);
  }

  @Override
  public boolean isEmpty()
  {
    return this.list.isEmpty();
  }

  @Override
  public Iterator<UpdateToReplay> iterator()
  {
    return this.list.iterator();
  }

  @Override
  public boolean removeAll(Collection<?> c)
  {
    return this.list.removeAll(c);
  }

  @Override
  public boolean retainAll(Collection<?> c)
  {
    return this.list.retainAll(c);
  }

  @Override
  public int size()
  {
    return this.list.size();
  }

  @Override
  public Object[] toArray()
  {
    return this.list.toArray();
  }

  @Override
  public <T> T[] toArray(T[] a)
  {
    return this.list.toArray(a);
  }

}