NumberExpression

All Known Subinterfaces:

NumberBinding

All Known Implementing Classes:

DoubleBinding, DoubleExpression, FloatBinding, FloatExpression, IntegerBinding, IntegerExpression, LongBinding, LongExpression, NumberExpressionBase
```
public interface NumberExpression
```
NumberExpression is an javafx.beans.value.ObservableNumberValue plus additional convenience methods to generate bindings in a fluent style.
This API allows to mix types when defining arithmetic operations. The type of the result is defined by the same rules as in the Java Language.
1. If one of the operands is a double, the result is a double.
2. If not and one of the operands is a float, the result is a float.
3. If not and one of the operands is a long, the result is a long.
4. The result is an integer otherwise.
To be able to deal with an unspecified return type, two interfaces NumberExpression and its counterpart NumberBinding were introduced. That means if the return type is specified as NumberBinding, the method will either return a DoubleBinding, FloatBinding, LongBinding or IntegerBinding, depending on the types of the operands.
The API tries to do its best in determining the correct return type, e.g. combining a javafx.beans.value.ObservableNumberValue with a primitive double will always result in a DoubleBinding. In cases where the return type is not known by the API, it is the responsibility of the developer to call the correct getter (#intValue() etc.). If the internal representation does not match the type of the getter, a standard cast is done.
Since:

JavaFX 2.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`NumberBinding`	`add(ObservableNumberValue other)` Creates a new `NumberBinding` that calculates the sum of this `NumberExpression` and another `javafx.beans.value.ObservableNumberValue`.
`StringBinding`	`asString()` Creates a `StringBinding` that holds the value of the `NumberExpression` turned into a `String`.
`StringBinding`	`asString(java.util.Locale locale, java.lang.String format)` Creates a `StringBinding` that holds the value of the `NumberExpression` turned into a `String`.
`StringBinding`	`asString(java.lang.String format)` Creates a `StringBinding` that holds the value of the `NumberExpression` turned into a `String`.
`NumberBinding`	`divide(ObservableNumberValue other)` Creates a new `NumberBinding` that calculates the division of this `NumberExpression` and another `javafx.beans.value.ObservableNumberValue`.
`BooleanBinding`	`greaterThan(ObservableNumberValue other)` Creates a new `BooleanBinding` that holds `true` if this `NumberExpression` is greater than another `javafx.beans.value.ObservableNumberValue`.
`BooleanBinding`	`greaterThanOrEqualTo(ObservableNumberValue other)` Creates a new `BooleanBinding` that holds `true` if this `NumberExpression` is greater than or equal to another `javafx.beans.value.ObservableNumberValue`.
`BooleanBinding`	`isEqualTo(ObservableNumberValue other)` Creates a new `BooleanBinding` that holds `true` if this and another `javafx.beans.value.ObservableNumberValue` are equal.
`BooleanBinding`	`isEqualTo(ObservableNumberValue other, double epsilon)` Creates a new `BooleanBinding` that holds `true` if this and another `javafx.beans.value.ObservableNumberValue` are equal (with a tolerance).
`BooleanBinding`	`isNotEqualTo(ObservableNumberValue other)` Creates a new `BooleanBinding` that holds `true` if this and another `javafx.beans.value.ObservableNumberValue` are not equal.
`BooleanBinding`	`isNotEqualTo(ObservableNumberValue other, double epsilon)` Creates a new `BooleanBinding` that holds `true` if this and another `javafx.beans.value.ObservableNumberValue` are not equal (with a tolerance).
`BooleanBinding`	`lessThan(ObservableNumberValue other)` Creates a new `BooleanBinding` that holds `true` if this `NumberExpression` is lesser than another `javafx.beans.value.ObservableNumberValue`.
`BooleanBinding`	`lessThanOrEqualTo(ObservableNumberValue other)` Creates a new `BooleanBinding` that holds `true` if this `NumberExpression` is less than or equal to another `javafx.beans.value.ObservableNumberValue`.
`NumberBinding`	`multiply(ObservableNumberValue other)` Creates a new `NumberBinding` that calculates the product of this `NumberExpression` and another `javafx.beans.value.ObservableNumberValue`.
`NumberBinding`	`negate()` Creates a new `NumberBinding` that calculates the negation of `NumberExpression`.
`NumberBinding`	`subtract(ObservableNumberValue other)` Creates a new `NumberBinding` that calculates the difference of this `NumberExpression` and another `javafx.beans.value.ObservableNumberValue`.

- Method Detail
  - negate
```
NumberBinding negate()
```
    Creates a new NumberBinding that calculates the negation of NumberExpression.
    
    Returns:
    
    the new NumberBinding
  - add
```
NumberBinding add(ObservableNumberValue other)
```
    Creates a new NumberBinding that calculates the sum of this NumberExpression and another javafx.beans.value.ObservableNumberValue.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new NumberBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - subtract
```
NumberBinding subtract(ObservableNumberValue other)
```
    Creates a new NumberBinding that calculates the difference of this NumberExpression and another javafx.beans.value.ObservableNumberValue.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new NumberBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - multiply
```
NumberBinding multiply(ObservableNumberValue other)
```
    Creates a new NumberBinding that calculates the product of this NumberExpression and another javafx.beans.value.ObservableNumberValue.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new NumberBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - divide
```
NumberBinding divide(ObservableNumberValue other)
```
    Creates a new NumberBinding that calculates the division of this NumberExpression and another javafx.beans.value.ObservableNumberValue.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new NumberBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - isEqualTo
```
BooleanBinding isEqualTo(ObservableNumberValue other)
```
    Creates a new BooleanBinding that holds true if this and another javafx.beans.value.ObservableNumberValue are equal.
    When comparing floating-point numbers it is recommended to use the isEqualTo() method that allows a small tolerance.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new BooleanBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - isEqualTo
```
BooleanBinding isEqualTo(ObservableNumberValue other,
                         double epsilon)
```
    Creates a new BooleanBinding that holds true if this and another javafx.beans.value.ObservableNumberValue are equal (with a tolerance).
    Two operands a and b are considered equal if Math.abs(a-b) <= epsilon.
    Allowing a small tolerance is recommended when comparing floating-point numbers because of rounding-errors.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    epsilon - the tolerance
    
    Returns:
    
    the new BooleanBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - isNotEqualTo
```
BooleanBinding isNotEqualTo(ObservableNumberValue other)
```
    Creates a new BooleanBinding that holds true if this and another javafx.beans.value.ObservableNumberValue are not equal.
    When comparing floating-point numbers it is recommended to use the isNotEqualTo() method that allows a small tolerance.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new BooleanBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - isNotEqualTo
```
BooleanBinding isNotEqualTo(ObservableNumberValue other,
                            double epsilon)
```
    Creates a new BooleanBinding that holds true if this and another javafx.beans.value.ObservableNumberValue are not equal (with a tolerance).
    Two operands a and b are considered not equal if Math.abs(a-b) > epsilon.
    Allowing a small tolerance is recommended when comparing floating-point numbers because of rounding-errors.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    epsilon - the permitted tolerance
    
    Returns:
    
    the new BooleanBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - greaterThan
```
BooleanBinding greaterThan(ObservableNumberValue other)
```
    Creates a new BooleanBinding that holds true if this NumberExpression is greater than another javafx.beans.value.ObservableNumberValue.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new BooleanBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - lessThan
```
BooleanBinding lessThan(ObservableNumberValue other)
```
    Creates a new BooleanBinding that holds true if this NumberExpression is lesser than another javafx.beans.value.ObservableNumberValue.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new BooleanBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - greaterThanOrEqualTo
```
BooleanBinding greaterThanOrEqualTo(ObservableNumberValue other)
```
    Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to another javafx.beans.value.ObservableNumberValue.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new BooleanBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - lessThanOrEqualTo
```
BooleanBinding lessThanOrEqualTo(ObservableNumberValue other)
```
    Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to another javafx.beans.value.ObservableNumberValue.
    
    Parameters:
    
    other - the second ObservableNumberValue
    
    Returns:
    
    the new BooleanBinding
    
    Throws:
    
    java.lang.NullPointerException - if the other ObservableNumberValue is null
  - asString
```
StringBinding asString()
```
    Creates a StringBinding that holds the value of the NumberExpression turned into a String. If the value of this NumberExpression changes, the value of the StringBinding will be updated automatically.
    The conversion is done without any formatting applied.
    
    Returns:
    
    the new StringBinding
  - asString
```
StringBinding asString(java.lang.String format)
```
    Creates a StringBinding that holds the value of the NumberExpression turned into a String. If the value of this NumberExpression changes, the value of the StringBinding will be updated automatically.
    The result is formatted according to the formatting String. See java.util.Formatter for formatting rules.
    
    Parameters:
    
    format - the formatting String
    
    Returns:
    
    the new StringBinding
  - asString
```
StringBinding asString(java.util.Locale locale,
                       java.lang.String format)
```
    Creates a StringBinding that holds the value of the NumberExpression turned into a String. If the value of this NumberExpression changes, the value of the StringBinding will be updated automatically.
    The result is formatted according to the formatting String and the passed in Locale. See java.util.Formatter for formatting rules. See java.util.Locale for details on Locale.
    
    Parameters:
    
    locale - the Locale to be used
    
    format - the formatting String
    
    Returns:
    
    the new StringBinding

Interface NumberExpression

Method Summary

Method Detail

negate

add

subtract

multiply

divide

isEqualTo

isEqualTo

isNotEqualTo

isNotEqualTo

greaterThan

lessThan

greaterThanOrEqualTo

lessThanOrEqualTo

asString

asString

asString