it.sauronsoftware.cron4j.TaskTable Maven / Gradle / Ivy

Go to download
/*
 * cron4j - A pure Java cron-like scheduler
 * 
 * Copyright (C) 2007-2010 Carlo Pelliccia (www.sauronsoftware.it)
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version
 * 2.1, as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License 2.1 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License version 2.1 along with this program.
 * If not, see .
 */
package it.sauronsoftware.cron4j;

import java.util.ArrayList;

/**
 * 
 * A table coupling tasks with scheduling patterns.
 * 
 * 
 * @author Carlo Pelliccia
 * @since 2.0
 */
public class TaskTable {

	/**
	 * Table size.
	 */
	private int size = 0;

	/**
	 * Pattern list.
	 */
	private ArrayList patterns = new ArrayList();

	/**
	 * Task list.
	 */
	private ArrayList tasks = new ArrayList();

	/**
	 * Adds a task and an associated scheduling pattern to the table.
	 * 
	 * @param pattern
	 *            The associated scheduling pattern.
	 * @param task
	 *            The task.
	 */
	public void add(SchedulingPattern pattern, Task task) {
		patterns.add(pattern);
		tasks.add(task);
		size++;
	}

	/**
	 * Returns the size of the table, representing the number of the elements
	 * stored in it.
	 * 
	 * @return The table size.
	 */
	public int size() {
		return size;
	}

	/**
	 * Returns the task at the specified position. Valid positions are between
	 * 0 to {@link TaskTable#size()} - 1.
	 * 
	 * @param index
	 *            The index.
	 * @return The task at the specified position.
	 * @throws IndexOutOfBoundsException
	 *             If the supplied index is out of range.
	 */
	public Task getTask(int index) throws IndexOutOfBoundsException {
		return (Task) tasks.get(index);
	}

	/**
	 * Returns the scheduling pattern at the specified position. Valid positions
	 * are between 0 to {@link TaskTable#size()} - 1.
	 * 
	 * @param index
	 *            The index.
	 * @return The scheduling pattern at the specified position.
	 * @throws IndexOutOfBoundsException
	 *             If the supplied index is out of range.
	 */
	public SchedulingPattern getSchedulingPattern(int index)
			throws IndexOutOfBoundsException {
		return (SchedulingPattern) patterns.get(index);
	}

	/**
	 * Remove a task from the table.
	 * 
	 * @param index
	 *            The index of the task to remove.
	 * @throws IndexOutOfBoundsException
	 *             If the supplied index is not valid.
	 * @since 2.1
	 */
	public void remove(int index) throws IndexOutOfBoundsException {
		tasks.remove(index);
		patterns.remove(index);
		size--;
	}

}