azkaban.utils.SwapQueue Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012 LinkedIn Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package azkaban.utils;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;

/**
 * Queue that swaps its lists. Allows for non-blocking writes when reading. Swap should be called
 * before every read.
 */
public class SwapQueue implements Iterable {

  ArrayList primaryQueue;
  ArrayList secondaryQueue;

  public SwapQueue() {
    this.primaryQueue = new ArrayList<>();
    this.secondaryQueue = new ArrayList<>();
  }

  /**
   * Swaps primaryQueue with secondary queue. The previous primary queue will be released.
   */
  public synchronized void swap() {
    this.primaryQueue = this.secondaryQueue;
    this.secondaryQueue = new ArrayList<>();
  }

  /**
   * Returns a count of the secondary queue.
   */
  public synchronized int getSwapQueueSize() {
    return this.secondaryQueue.size();
  }

  public synchronized int getPrimarySize() {
    return this.primaryQueue.size();
  }

  public synchronized void addAll(final Collection col) {
    this.secondaryQueue.addAll(col);
  }

  /**
   * Returns both the secondary and primary size
   */
  public synchronized int getSize() {
    return this.secondaryQueue.size() + this.primaryQueue.size();
  }

  public synchronized void add(final T element) {
    this.secondaryQueue.add(element);
  }

  /**
   * Returns iterator over the primary queue.
   */
  @Override
  public synchronized Iterator iterator() {
    return this.primaryQueue.iterator();
  }
}