001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.image.mask;
031
032import org.openimaj.image.Image;
033
034/**
035 * Abstract base implementation of a {@link MaskedObject}.
036 * 
037 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
038 *
039 * @param <M> The {@link Image} type of the mask.
040 */
041public abstract class AbstractMaskedObject<M extends Image<?,M>> implements MaskedObject<M> {
042        protected M mask;
043        
044        /**
045         * Default constructor with a <code>null</code> mask.
046         */
047        public AbstractMaskedObject() {}
048        
049        /**
050         * Construct with the given mask.
051         * @param mask the mask.
052         */
053        public AbstractMaskedObject(M mask) {
054                this.mask = mask;
055        }
056        
057        /* (non-Javadoc)
058         * @see org.openimaj.image.processor.MaskedImageProcessor#getMask()
059         */
060        @Override
061        public M getMask() {
062                return mask;
063        }
064        
065        /* (non-Javadoc)
066         * @see org.openimaj.image.processor.MaskedImageProcessor#setMask(org.openimaj.image.Image)
067         */
068        @Override
069        public void setMask(M mask) {
070                this.mask = mask;
071        }
072}