PipelineBuffer.java

/**
 * ****************************************************************************
 * Copyright (c) 2010-2016 by Min Cai (min.cai.china@gmail.com).
 * <p>
 * This file is part of the Archimulator multicore architectural simulator.
 * <p>
 * Archimulator is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * <p>
 * Archimulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with Archimulator. If not, see <http://www.gnu.org/licenses/>.
 * ****************************************************************************
 */
package archimulator.core;

import java.util.ArrayList;
import java.util.List;

/**
 * Pipeline buffer.
 *
 * @param <EntryT>
 * @author Min Cai
 */
public class PipelineBuffer<EntryT> {
    private int capacity;
    private List<EntryT> entries;

    /**
     * Create a pipeline buffer.
     *
     * @param capacity the capacity of the pipeline buffer
     */
    public PipelineBuffer(int capacity) {
        this.capacity = capacity;
        this.entries = new ArrayList<>();
    }

    /**
     * Get a value indicating whether the pipeline buffer is full or not.
     *
     * @return a value indicating whether the pipeline buffer is full or not
     */
    public boolean isFull() {
        return this.entries.size() >= this.capacity;
    }

    /**
     * Get a value indicating whether the pipeline buffer is empty or not.
     *
     * @return a value indicating whether the pipeline buffer is empty or not
     */
    public boolean isEmpty() {
        return this.entries.isEmpty();
    }

    /**
     * Get the capacity of the pipeline buffer.
     *
     * @return the capacity of the pipeline buffer
     */
    public int getCapacity() {
        return capacity;
    }

    /**
     * Get the list of entries.
     *
     * @return the list of entries
     */
    public List<EntryT> getEntries() {
        return entries;
    }
}