circularintegerbuffer.java

MegaMek is a networked Java clone of BattleTech, a turn-based sci-fi boardgame for 2+ players. Fight

/*
 * MegaMek -
 * Copyright (C) 2000,2001,2002,2003,2004,2005 Ben Mazur ([e-mail])
 *
 *  This program 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 2 of the License, or (at your option)
 *  any later version.
 *
 *  This program 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.
 */

/* Written by Ryan McConnell (oscarmm)
 * Created: May 22, 2005
 */

package megamek.common.util;

public class CircularIntegerBuffer {

    private int begin;
    private int end;
    private int[] buffer;

    /**
     * Creates the new buffer 
     * @param size required size 
     */
    public CircularIntegerBuffer(int size) {
        buffer = new int[size];
        clear();
    }

    /**
     * Returns the length of this buffer
     * @return length of this buffer
     */
    public int length() {
        return buffer.length;
    }
    
    /**
     * Clears the buffer
     *
     */
    public void clear() {
        begin = buffer.length - 1;
        end = -1;
    }

    /**
     * Adds new value
     * @param value value to add
     */
    public void push(int value) {
        end++;
        if (end > begin) {
            begin++;
            if (begin == buffer.length)
                begin = 0;
        }
        if (end == buffer.length)
            end = 0;
        buffer[end] = value;
    }

    public String toString() {
        StringBuffer result = new StringBuffer();

        int indexBegin = begin + 1;
        if (indexBegin == buffer.length)
            indexBegin = 0;

        if (indexBegin <= end) {
            for (int i = indexBegin; i <= end; i++) {
                result.append(buffer[i]).append(" ");
            }
        } else {
            for (int i = indexBegin; i < buffer.length; i++) {
                result.append(buffer[i]).append(" ");
            }
            for (int i = 0; i <= end; i++) {
                result.append(buffer[i]).append(" ");
            }
        }
        return result.toString();
    }
}