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.data.identity;
031
032/**
033 * A simple implementation of {@link Identifiable} that wraps another object.
034 * 
035 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
036 * 
037 * @param <T>
038 */
039public class IdentifiableObject<T> implements Identifiable {
040        /**
041         * The identity
042         */
043        public final String identity;
044
045        /**
046         * The data
047         */
048        public final T data;
049
050        /**
051         * Construct with the given identity and data.
052         * 
053         * @param ident
054         *            the identity
055         * @param data
056         *            the data to wrap
057         */
058        public IdentifiableObject(String ident, T data) {
059                this.identity = ident;
060                this.data = data;
061        }
062
063        @Override
064        public String getID() {
065                return identity;
066        }
067
068        @Override
069        public boolean equals(Object obj) {
070                if (!(obj instanceof Identifiable))
071                        return false;
072
073                return identity.equals(((Identifiable) obj).getID());
074        }
075}