001    /*
002     * Copyright (C) 2008-2010 by Holger Arndt
003     *
004     * This file is part of the Universal Java Matrix Package (UJMP).
005     * See the NOTICE file distributed with this work for additional
006     * information regarding copyright ownership and licensing.
007     *
008     * UJMP is free software; you can redistribute it and/or modify
009     * it under the terms of the GNU Lesser General Public License as
010     * published by the Free Software Foundation; either version 2
011     * of the License, or (at your option) any later version.
012     *
013     * UJMP is distributed in the hope that it will be useful,
014     * but WITHOUT ANY WARRANTY; without even the implied warranty of
015     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
016     * GNU Lesser General Public License for more details.
017     *
018     * You should have received a copy of the GNU Lesser General Public
019     * License along with UJMP; if not, write to the
020     * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
021     * Boston, MA  02110-1301  USA
022     */
023    
024    package org.ujmp.core.interfaces;
025    
026    /**
027     * Classes implementing this interface indicate, that they act as a wrapper for
028     * another class.
029     * 
030     * 
031     * @param <A>
032     *            The class that is wrapped inside
033     */
034    public interface Wrapper<A> {
035    
036            /**
037             * Returns the object that is wrapped inside the wrapper
038             * 
039             * @return the inner object
040             */
041            public A getWrappedObject();
042    
043            /**
044             * Sets the object that is wrapped inside the wrapper
045             * 
046             * @param object
047             *            new objects to wrap
048             */
049            public void setWrappedObject(A object);
050    }