1 /*
   2  * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javafx.beans.value;
  27 
  28 /**
  29  * A common interface of all sub-interfaces of {@link ObservableValue} that wrap
  30  * a number.
  31  *
  32  * @param T
  33  *            The type of the wrapped value (a {@code Number}).
  34  *
  35  * @see ObservableValue
  36  * @see ObservableDoubleValue
  37  * @see ObservableFloatValue
  38  * @see ObservableIntegerValue
  39  * @see ObservableLongValue
  40  *
  41  *
  42  * @since JavaFX 2.0
  43  */
  44 public interface ObservableNumberValue extends ObservableValue<Number> {
  45 
  46     /**
  47      * Returns the value of this {@code ObservableNumberValue} as an {@code int}
  48      * . If the value is not an {@code int}, a standard cast is performed.
  49      *
  50      * @return The value of this {@code ObservableNumberValue} as an {@code int}
  51      */
  52     int intValue();
  53 
  54     /**
  55      * Returns the value of this {@code ObservableNumberValue} as a {@code long}
  56      * . If the value is not a {@code long}, a standard cast is performed.
  57      *
  58      * @return The value of this {@code ObservableNumberValue} as a {@code long}
  59      */
  60     long longValue();
  61 
  62     /**
  63      * Returns the value of this {@code ObservableNumberValue} as a
  64      * {@code float}. If the value is not a {@code float}, a standard cast is
  65      * performed.
  66      *
  67      * @return The value of this {@code ObservableNumberValue} as a
  68      *         {@code float}
  69      */
  70     float floatValue();
  71 
  72     /**
  73      * Returns the value of this {@code ObservableNumberValue} as a
  74      * {@code double}. If the value is not a {@code double}, a standard cast is
  75      * performed.
  76      *
  77      * @return The value of this {@code ObservableNumberValue} as a
  78      *         {@code double}
  79      */
  80     double doubleValue();
  81 
  82 }