001/* A mapping from objects into int values.
002
003 Copyright (c) 2003-2013 The University of Maryland.
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 MARYLAND 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 MARYLAND HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF MARYLAND 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 MARYLAND HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 */
025package ptolemy.graph.mapping;
026
027///////////////////////////////////////////////////////////////////
028//// ToIntMapping
029
030/** A mapping from objects into int values.
031
032 @since Ptolemy II 4.0
033 @Pt.ProposedRating Red (ssb)
034 @Pt.AcceptedRating Red (ssb)
035 @author Shuvra S. Bhattacharyya, Shahrooz Shahparnia
036 @version $Id$
037 */
038public interface ToIntMapping extends Mapping {
039    ///////////////////////////////////////////////////////////////////
040    ////                         public methods                    ////
041
042    /** Return the int value associated with the given object.
043     *  @param object The given object.
044     *  @return The int value that is associated with given object under
045     *  this mapping.
046     */
047    public int toInt(Object object);
048}