001/* An abstract class that tokens which contain images should derive from.
002
003 Copyright (c) 2002-2015 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026 */
027package ptolemy.data;
028
029import java.awt.Image;
030
031///////////////////////////////////////////////////////////////////
032//// ImageToken
033
034/**
035 An abstract class that all tokens which encapsulate images should extend.
036 Each class that extends this class is required to implement the method
037 asAWTImage(), so that it may be used with the standard image processing
038 library.
039
040 @author James Yeh
041 @version $Id$
042 @since Ptolemy II 3.0
043 @Pt.ProposedRating Red (cxh)
044 @Pt.AcceptedRating Red (cxh)
045 */
046public abstract class ImageToken extends ObjectToken {
047    /** Construct an empty token.
048     */
049    public ImageToken() {
050        super();
051    }
052
053    ///////////////////////////////////////////////////////////////////
054    ////                         public methods                    ////
055
056    /** Return the value of this token as a java.awt.Image.
057     *  @return The image.
058     */
059    public abstract Image asAWTImage();
060}