/* 
 * This code is part of Project Waterloo from King's College London
 * 
 *
 * Copyright King's College London  2011-
 * 
 * @author Malcolm Lidierth, King's College London  [Contact]
 * 
 * Project Waterloo is free software:  you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Project Waterloo 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 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 *
 */
package kcl.waterloo.annotation;

import java.util.ArrayList;

/**
 * Specifies the methods required for a container to support annotations.
 *
 * @param  for a Swing container, Path2D
 * @param  for a Swing container, GJGraphInterface
 * @param  for a Swing container, Stroke
 * @param  for a Swing container, Paint
 * @param  for a Swing container, Font
 *
 * @author Malcolm Lidierth, King's College London  [Contact]
 */
public interface GJAnnotatableInterface {

    /**
     * Adds an annotation to the set.
     *
     * @param a the annotation to add.
     */
    public void add(GJAnnotationInterface a);

    /**
     * Returns an ArrayList of annotations
     *
     * @return the ArrayList
     */
    public ArrayList> getAnnotations();

    /**
     * Replaces the ArrayList of annotations with the supplied instance.
     *
     * @param a an ArrayList
     */
    public void setAnnotations(ArrayList> a);
}