/*
* 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 TextParagraphElement} instances.
*
* @author Fromentin Xavier, Schnell Michaël, Dervin Cyrielle, Brabant Quentin
* @version 1.0
*/
public class Elements implements Iterable<TextParagraphElement>, Serializable {
/**
* Needed to serialize this class.
*
* @see java.io.Serializable
*/
private static final long serialVersionUID = 5315344952639998423L ;
/**
* List of the instances of {@code TextParagraphElement}.
*/
protected List<TextParagraphElement> elements ;
/**
* Builds an empty instance of {@code Elements}.
*/
public Elements() {
super() ;
this.elements = new ArrayList<TextParagraphElement>() ;
}// Elements()
/**
* Add an instance of {@code TextParagraphElement} at the specified index.
*
* <p>Adding an {@code TextParagraphElement} at the end of the list
* ({@code index == getCount()}) causes the {@code TextParagraphElement}
* to be appended.
*
* @param p
* instance of {@code TextParagraphElement} added
*
* @param index
* insert position
*
* @throws InvalidIndexException
* if the given index is out of range
* {@code index < 0 || index > getCount()}
*/
public void add(TextParagraphElement p, int index) throws InvalidIndexException {
if (index == this.getCount()) {
this.append(p) ;
} else {
this.checkIndex(index) ;
this.elements.add(index, p) ;
}// if
}// add(TextParagraphElement, int)
/**
* Prepends an instance of {@code Paragraph}.
*
* @param p
* instance of {@code Paragraph} prepended
*/
public void push(TextParagraphElement p) {
if (this.getCount() == 0) {
this.elements.add(p) ;
} else {
this.elements.add(0, p) ;
}// if
}// push(TextParagraphElement)
/**
* Appends an instance of {@code Paragraph}.
*
* @param p
* instance of {@code Paragraph} appended
*/
public void append(TextParagraphElement p) {
this.elements.add(p) ;
}// append(TextParagraphElement)
/**
* Removes the instance of {@code TextParagraphElement} found at the given index.
*
* @param index
* index of the removed {@code TextParagraphElement}
*
* @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.elements.remove(index) ;
}// remove(int)
/**
* Removes all the instances matching the given {@code TextParagraphElement}.
*
* @param p
* removed {@code TextParagraphElement}
*/
public void remove(TextParagraphElement p) {
boolean stillPresent = this.elements.remove(p) ;
while (stillPresent) {
stillPresent = this.elements.remove(p) ;
}// while
}// remove(TextParagraphElement)
/**
* Returns the number of instance of {@code TextParagraphElement} contained
* in this instance.
*
* @return Number of instance of {@code TextParagraphElement} contained in
* this instance
*/
public int getCount() {
return this.elements.size() ;
}// getCount()
/**
* Returns an iterator for this instance.
*
* <p>The iterator iterates over the document sequentially.
*
* @return an instance of {@code Iterator<TextParagraphElement>} for this instance
*/
@Override
public Iterator<TextParagraphElement> iterator() {
return this.elements.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.elements.size())) {
throw new InvalidIndexException(index) ;
}// if
}// checkIndex(int)
}// class Elements