//
// AbstractROIOverlay.java
//

/*
ImageJ software for multidimensional image processing and analysis.

Copyright (c) 2010, ImageJDev.org.
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.
    * Neither the names of the ImageJDev.org developers nor the
      names of its contributors may 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 THE COPYRIGHT HOLDERS OR CONTRIBUTORS 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 imagej.data.roi;

import net.imglib2.roi.RegionOfInterest;

/**
 * An overlay that has an associated region of interest
 * 
 * @author Lee Kamentsky
 */
public abstract class AbstractROIOverlay<R extends RegionOfInterest> extends
	AbstractOverlay
{

	private static final long serialVersionUID = 1L;

	private final R roi;

	protected AbstractROIOverlay(final R roi) {
		this.roi = roi;
	}

	/* (non-Javadoc)
	 * @see imagej.data.roi.AbstractOverlay#getRegionOfInterest()
	 */
	@Override
	public R getRegionOfInterest() {
		return roi;
	}

}

@@ -2039,91 +2039,287 @@
 %0A%0A%09/
-* (non-Javadoc)%0A%09 * @see imagej.data.roi.AbstractOverlay#getRegionOfInterest()%0A%09 */
+/ TODO - Have this class implement ROIOverlay which defines%0A%09// getRegionOfInterest(), rather than having the base Overlay interface have%0A%09// that method. This avoids confusion with non-ROI Overlay implementation (so%0A%09// no getRegionOfInterest() method returning null for them).%0A
 %0A%09@O

Add TODO about future refactoring of ROIOverlay.