package ie.dcu.segment.annotate;

/**
 * Class to simplify implementation of annotation listeners. For use when the
 * listener is only interested in changes in the generic sense.
 * 
 * @see AnnotationListener
 * @author Kevin McGuinness
 */
public abstract class AnnotationAdapter implements AnnotationListener {

	/**
	 * Forwards call to {@link #annotationsChanged(AnnotationEvent)}
	 */
	public void annotationPerformed(AnnotationEvent e) {
		annotationsChanged(e);
	}
	
	/**
	 * Forwards call to {@link #annotationsChanged(AnnotationEvent)}
	 */
	public void annotationRedone(AnnotationEvent e) {
		annotationsChanged(e);
	}

	/**
	 * Forwards call to {@link #annotationsChanged(AnnotationEvent)}
	 */
	public void annotationUndone(AnnotationEvent e) {
		annotationsChanged(e);
	}

	/**
	 * Forwards call to {@link #annotationsChanged(AnnotationEvent)}
	 */
	public void annotationsCleared(AnnotationEvent e) {
		annotationsChanged(e);
	}
	
	/**
	 * Called when any changes to the annotations occur.
	 * 
	 * @param e The {@link AnnotationEvent} object.
	 */
	public abstract void annotationsChanged(AnnotationEvent e);
}