Package kameleon.document

Source Code of kameleon.document.Cells

/*
* Copyright (c) 2012, Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*      * Redistributions of source code must retain the above copyright
*       notice, this list of conditions and the following disclaimer.
*      * Redistributions in binary form must reproduce the above copyright
*       notice, this list of conditions and the following disclaimer in the
*       documentation and/or other materials provided with the distribution.
*      * The names of its contributors may not be used to endorse or promote products
*       derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL Fromentin Xavier, Schnell Michaël, Dervin Cyrielle OR Brabant Quentin
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package kameleon.document;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

import kameleon.exception.InvalidIndexException;

/**
* Manages a collection of {@code Cell} instances.
*
* @author    Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
* @version    1.0
*/
public class Cells implements Iterable<Cell>, Serializable {

  /**
   * Needed to serialize this class.
   *
   * @see    java.io.Serializable
   */
  private static final long serialVersionUID = 6721932900022133429L ;
 
  /**
   * List of the instances of {@code Cell}.
   */
  protected List<Cell> cells ;
 
  /**
   * Builds an empty instance of {@code Cells}.
   */
  public Cells() {
    super() ;
    this.cells = new ArrayList<Cell>() ;
  }// Cells()

  /**
   * Add an instance of {@code Cell} at the specified index.
   *
   * @param   c
   *       instance of {@code Cell} added
   *
   * @param   index
   *       insert position
   *
   * @throws  InvalidIndexException
   *       if the given index is out of range
   *       {@code index < 0 || index >= getCount()}
   */
  public void add(Cell c, int index) throws InvalidIndexException {
    this.checkIndex(index) ;
    this.cells.add(index, c) ;
  }// add(Cell, int)

    /**
     * Prepends an instance of {@code Cell}.
   *
   * @param   c
   *       instance of {@code Cell} prepended
     */
    public void push(Cell c) {
      if (this.getCount() == 0) {
        this.cells.add(c) ;
      } else {
        this.cells.add(0, c) ;
      }// if
    }// push(Cell)

    /**
     * Appends an instance of {@code Cell}.
   *
   * @param   c
   *       instance of {@code Cell} appended
     */
    public void append(Cell c) {
      this.cells.add(c) ;
    }// append(Cell)

    /**
     * Removes the instance of {@code Cell} found at the given index.
   *
   * @param   index
   *       index of the removed {@code Cell}
   *
   * @throws  InvalidIndexException
   *       if the given index is out of range
   *       {@code index < 0 || index >= getCount()}
     */
    public void remove(int index) throws InvalidIndexException {
      this.checkIndex(index) ;
      this.cells.remove(index) ;
    }// remove(int)

    /**
   * Removes all the instances matching the given {@code Cell}.
   *
   * @param   c
   *       removed {@code Cell}
   */
    public void remove(Cell c) {
      boolean stillPresent = this.cells.remove(c) ;
    while (stillPresent) {
      stillPresent = this.cells.remove(c) ;
    }// while
    }// remove(Cell)

    /**
     * Returns the number of instance of {@code Cell} contained
     * in this instance.
   *
   * @return  Number of instance of {@code Cell} contained in
   *       this instance
     */
    public int getCount() {
        return this.cells.size() ;
    }// getCount()
   
    /**
   * Returns the instance of {@code Cell} contained at the given index.
   *
   * @param  index
   *       index of the requested {@code Cell}
   *
   * @return  the instance of {@code Cell} at the given index
   *
   * @see    Cells#getCell(int)
   */
  public Cell getCell(int index) {
    return this.cells.get(index) ;
  }// getCell()

    /**
   * Returns an iterator for this instance.
   *
   * <p>The iterator iterates over the cells sequentially.
   *
   * @return  an instance of {@code Iterator<Cell>} for this instance
   */
  @Override
  public Iterator<Cell> iterator() {
    return this.cells.iterator() ;
  }// iterator()

  /**
   * Checks if the given index is a valid index for this instance.
   *
   * <p>If the index is valid, no exception is thrown.
   *
   * @param   index
   *       checked index
   *
   * @throws   InvalidIndexException
   *       if the given index is out of range
   *       {@code index < 0 || index >= getCount()}
   */
  protected void checkIndex(int index) throws InvalidIndexException {
    if ((index < 0) || (index >= this.cells.size())) {
      throw new InvalidIndexException(index) ;
    }// if
  }// checkIndex(int)

}// class Cells
TOP

Related Classes of kameleon.document.Cells

TOP
Copyright © 2018 www.massapi.com. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.