Source code

001/*
002 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package javafx.beans.value;
027
028/**
029 * A common interface of all sub-interfaces of {@link ObservableValue} that wrap
030 * a number.
031 * 
032 * @param T
033 *            The type of the wrapped value (a {@code Number}).
034 * 
035 * @see ObservableValue
036 * @see ObservableDoubleValue
037 * @see ObservableFloatValue
038 * @see ObservableIntegerValue
039 * @see ObservableLongValue
040 * 
041 * 
042 */
043public interface ObservableNumberValue extends ObservableValue<Number> {
044
045    /**
046     * Returns the value of this {@code ObservableNumberValue} as an {@code int}
047     * . If the value is not an {@code int}, a standard cast is performed.
048     * 
049     * @return The value of this {@code ObservableNumberValue} as an {@code int}
050     */
051    int intValue();
052
053    /**
054     * Returns the value of this {@code ObservableNumberValue} as a {@code long}
055     * . If the value is not a {@code long}, a standard cast is performed.
056     * 
057     * @return The value of this {@code ObservableNumberValue} as a {@code long}
058     */
059    long longValue();
060
061    /**
062     * Returns the value of this {@code ObservableNumberValue} as a
063     * {@code float}. If the value is not a {@code float}, a standard cast is
064     * performed.
065     * 
066     * @return The value of this {@code ObservableNumberValue} as a
067     *         {@code float}
068     */
069    float floatValue();
070
071    /**
072     * Returns the value of this {@code ObservableNumberValue} as a
073     * {@code double}. If the value is not a {@code double}, a standard cast is
074     * performed.
075     * 
076     * @return The value of this {@code ObservableNumberValue} as a
077     *         {@code double}
078     */
079    double doubleValue();
080
081}