Module javafx.base

Class NumberExpressionBase

java.lang.Object
javafx.beans.binding.NumberExpressionBase
All Implemented Interfaces:
NumberExpression, Observable, ObservableNumberValue, ObservableValue<Number>
Direct Known Subclasses:
DoubleExpression, FloatExpression, IntegerExpression, LongExpression

public abstract class NumberExpressionBase
extends Object
implements NumberExpression
NumberExpressionBase contains convenience methods to generate bindings in a fluent style, that are common to all NumberExpression subclasses.

NumberExpressionBase serves as a place for common code of specific NumberExpression subclasses for the specific number type.

Since:
JavaFX 2.0
See Also:
IntegerExpression, LongExpression, FloatExpression, DoubleExpression
  • Constructor Details

    • NumberExpressionBase

      public NumberExpressionBase()
      Creates a default NumberExpressionBase.
  • Method Details

    • numberExpression

      public static <S extends Number> NumberExpressionBase numberExpression​(ObservableNumberValue value)
      Returns an NumberExpressionBase that wraps a ObservableNumberValue. If the ObservableNumberValue is already an instance of NumberExpressionBase, it will be returned. Otherwise a new NumberBinding is created that is bound to the ObservableNumberValue.
      Type Parameters:
      S - The type of Number to be wrapped
      Parameters:
      value - The source ObservableNumberValue
      Returns:
      An NumberExpressionBase that wraps the ObservableNumberValue if necessary
      Throws:
      NullPointerException - if value is null
    • add

      public NumberBinding add​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new NumberBinding that calculates the sum of this NumberExpression and another ObservableNumberValue.
      Specified by:
      add in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new NumberBinding
    • subtract

      public NumberBinding subtract​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new NumberBinding that calculates the difference of this NumberExpression and another ObservableNumberValue.
      Specified by:
      subtract in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new NumberBinding
    • multiply

      public NumberBinding multiply​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new NumberBinding that calculates the product of this NumberExpression and another ObservableNumberValue.
      Specified by:
      multiply in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new NumberBinding
    • divide

      public NumberBinding divide​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new NumberBinding that calculates the division of this NumberExpression and another ObservableNumberValue.
      Specified by:
      divide in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new NumberBinding
    • isEqualTo

      public BooleanBinding isEqualTo​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this and another ObservableNumberValue are equal.

      When comparing floating-point numbers it is recommended to use the isEqualTo() method that allows a small tolerance.

      Specified by:
      isEqualTo in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new BooleanBinding
    • isEqualTo

      public BooleanBinding isEqualTo​(ObservableNumberValue other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this and another 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.

      Specified by:
      isEqualTo in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      epsilon - the tolerance
      Returns:
      the new BooleanBinding
    • isEqualTo

      public BooleanBinding isEqualTo​(double other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value (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.

      Specified by:
      isEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • isEqualTo

      public BooleanBinding isEqualTo​(float other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value (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.

      Specified by:
      isEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • isEqualTo

      public BooleanBinding isEqualTo​(long other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value.

      When comparing floating-point numbers it is recommended to use the isEqualTo() method that allows a small tolerance.

      Specified by:
      isEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • isEqualTo

      public BooleanBinding isEqualTo​(long other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value (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.

      Specified by:
      isEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • isEqualTo

      public BooleanBinding isEqualTo​(int other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value.

      When comparing floating-point numbers it is recommended to use the isEqualTo() method that allows a small tolerance.

      Specified by:
      isEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • isEqualTo

      public BooleanBinding isEqualTo​(int other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is equal to a constant value (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.

      Specified by:
      isEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • isNotEqualTo

      public BooleanBinding isNotEqualTo​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this and another ObservableNumberValue are not equal.

      When comparing floating-point numbers it is recommended to use the isNotEqualTo() method that allows a small tolerance.

      Specified by:
      isNotEqualTo in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new BooleanBinding
    • isNotEqualTo

      public BooleanBinding isNotEqualTo​(ObservableNumberValue other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this and another 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.

      Specified by:
      isNotEqualTo in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • isNotEqualTo

      public BooleanBinding isNotEqualTo​(double other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value (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.

      Specified by:
      isNotEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • isNotEqualTo

      public BooleanBinding isNotEqualTo​(float other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value (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.

      Specified by:
      isNotEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • isNotEqualTo

      public BooleanBinding isNotEqualTo​(long other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value.

      When comparing floating-point numbers it is recommended to use the isNotEqualTo() method that allows a small tolerance.

      Specified by:
      isNotEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • isNotEqualTo

      public BooleanBinding isNotEqualTo​(long other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value (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.

      Specified by:
      isNotEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • isNotEqualTo

      public BooleanBinding isNotEqualTo​(int other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value.

      When comparing floating-point numbers it is recommended to use the isNotEqualTo() method that allows a small tolerance.

      Specified by:
      isNotEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • isNotEqualTo

      public BooleanBinding isNotEqualTo​(int other, double epsilon)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is not equal to a constant value (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.

      Specified by:
      isNotEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      epsilon - the permitted tolerance
      Returns:
      the new BooleanBinding
    • greaterThan

      public BooleanBinding greaterThan​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than another ObservableNumberValue.
      Specified by:
      greaterThan in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new BooleanBinding
    • greaterThan

      public BooleanBinding greaterThan​(double other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than a constant value.
      Specified by:
      greaterThan in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • greaterThan

      public BooleanBinding greaterThan​(float other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than a constant value.
      Specified by:
      greaterThan in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • greaterThan

      public BooleanBinding greaterThan​(long other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than a constant value.
      Specified by:
      greaterThan in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • greaterThan

      public BooleanBinding greaterThan​(int other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than a constant value.
      Specified by:
      greaterThan in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • lessThan

      public BooleanBinding lessThan​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is lesser than another ObservableNumberValue.
      Specified by:
      lessThan in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new BooleanBinding
    • lessThan

      public BooleanBinding lessThan​(double other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is lesser than a constant value.
      Specified by:
      lessThan in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • lessThan

      public BooleanBinding lessThan​(float other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is lesser than a constant value.
      Specified by:
      lessThan in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • lessThan

      public BooleanBinding lessThan​(long other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is lesser than a constant value.
      Specified by:
      lessThan in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • lessThan

      public BooleanBinding lessThan​(int other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is lesser than a constant value.
      Specified by:
      lessThan in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • greaterThanOrEqualTo

      public BooleanBinding greaterThanOrEqualTo​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to another ObservableNumberValue.
      Specified by:
      greaterThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new BooleanBinding
    • greaterThanOrEqualTo

      public BooleanBinding greaterThanOrEqualTo​(double other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to a constant value.
      Specified by:
      greaterThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • greaterThanOrEqualTo

      public BooleanBinding greaterThanOrEqualTo​(float other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to a constant value.
      Specified by:
      greaterThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • greaterThanOrEqualTo

      public BooleanBinding greaterThanOrEqualTo​(long other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to a constant value.
      Specified by:
      greaterThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • greaterThanOrEqualTo

      public BooleanBinding greaterThanOrEqualTo​(int other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is greater than or equal to a constant value.
      Specified by:
      greaterThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • lessThanOrEqualTo

      public BooleanBinding lessThanOrEqualTo​(ObservableNumberValue other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to another ObservableNumberValue.
      Specified by:
      lessThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the second ObservableNumberValue
      Returns:
      the new BooleanBinding
    • lessThanOrEqualTo

      public BooleanBinding lessThanOrEqualTo​(double other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to a constant value.
      Specified by:
      lessThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • lessThanOrEqualTo

      public BooleanBinding lessThanOrEqualTo​(float other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to a constant value.
      Specified by:
      lessThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • lessThanOrEqualTo

      public BooleanBinding lessThanOrEqualTo​(long other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to a constant value.
      Specified by:
      lessThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • lessThanOrEqualTo

      public BooleanBinding lessThanOrEqualTo​(int other)
      Description copied from interface: NumberExpression
      Creates a new BooleanBinding that holds true if this NumberExpression is less than or equal to a constant value.
      Specified by:
      lessThanOrEqualTo in interface NumberExpression
      Parameters:
      other - the constant value
      Returns:
      the new BooleanBinding
    • asString

      public StringBinding asString()
      Description copied from interface: NumberExpression
      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.

      Specified by:
      asString in interface NumberExpression
      Returns:
      the new StringBinding
    • asString

      public StringBinding asString​(String format)
      Description copied from interface: NumberExpression
      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.

      Specified by:
      asString in interface NumberExpression
      Parameters:
      format - the formatting String
      Returns:
      the new StringBinding
    • asString

      public StringBinding asString​(Locale locale, String format)
      Description copied from interface: NumberExpression
      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.

      Specified by:
      asString in interface NumberExpression
      Parameters:
      locale - the Locale to be used
      format - the formatting String
      Returns:
      the new StringBinding