Overview | Package | Class | Tree | Deprecated | Index | Help
| Groovy JDK

## java.lang
Class Number

Method Summary
`int` | `abs()` Get the absolute value
`Number` | `and(Number right)` Bitwise AND together two Numbers.
`boolean` | `asBoolean()` Coerce a number to a boolean value.
`Object` | `asType(Class c)` Transform this number to a the given type, using the 'as' operator.
`int` | `compareTo(Character right)` Compare a Number and a Character.
`int` | `compareTo(Number right)` Compare two Numbers.
`Number` | `div(Character right)` Divide a Number by a Character.
`Number` | `div(Number right)` Divide two Numbers.
`void` | `downto(Number to, Closure closure)` Iterates from this number down to the given number, inclusive, decrementing by one each time.
`Number` | `intdiv(Character right)` Integer Divide a Number by a Character.
`Number` | `intdiv(Number right)` Integer Divide two Numbers.
`boolean` | `isCase(Number switchValue)` Special 'case' implementation for all numbers, which delegates to the `compareTo()` method for comparing numbers of different types.
`Number` | `leftShift(Number operand)` Implementation of the left shift operator for integral types.
`Number` | `minus(Character right)` Subtract a Character from a Number.
`Number` | `minus(Number right)` Substraction of two Numbers.
`Number` | `mod(Number right)` Performs a division modulus operation.
`Number` | `multiply(Character right)` Multiply a Number by a Character.
`Number` | `multiply(Number right)` Multiply two Numbers.
`Number` | `next()` Increment a Number by one.
`Number` | `or(Number right)` Bitwise OR together two numbers.
`String` | `plus(String right)` Appends a String to the string representation of this number.
`Number` | `plus(Character right)` Add a Number and a Character.
`Number` | `plus(Number right)` Add two numbers and return the result.
`Number` | `power(Number exponent)` Power of a Number to a certain exponent.
`Number` | `previous()` Decrement a Number by one.
`Number` | `rightShift(Number operand)` Implementation of the right shift operator for integral types.
`Number` | `rightShiftUnsigned(Number operand)` Implementation of the right shift (unsigned) operator for integral types.
`void` | `step(Number to, Number stepNumber, Closure closure)` Iterates from this number up to the given number using a step increment.
`void` | `times(Closure closure)` Executes the closure this many times, starting from zero.
`BigDecimal` | `toBigDecimal()` Transform a Number into a BigDecimal
`BigInteger` | `toBigInteger()` Transform this Number into a BigInteger.
`Double` | `toDouble()` Transform a Number into a Double
`Float` | `toFloat()` Transform a Number into a Float
`Integer` | `toInteger()` Transform a Number into an Integer
`Long` | `toLong()` Transform a Number into a Long
`Number` | `unaryMinus()` Negates the number.
`void` | `upto(Number to, Closure closure)` Iterates from this number up to the given number, inclusive, incrementing by one each time.
`Number` | `xor(Number right)` Bitwise XOR together two Numbers.

Method Detail

### abs

    public int abs()

  Get the absolute value

Returns:
  the absolute value of that Number

Since:
  1.0

### and

    public Number and(Number right)

  Bitwise AND together two Numbers.

Parameters:
  `right` - another Number to bitwise AND.

Returns:
  the bitwise AND of both Numbers

Since:
  1.0

### asBoolean

    public boolean asBoolean()

  Coerce a number to a boolean value. A number is coerced to false if its double value is equal to 0, and to true otherwise, and to true otherwise.

Returns:
  the boolean value

Since:
  1.7.0

### asType

    public Object asType(Class c)

  Transform this number to a the given type, using the 'as' operator. The following types are supported in addition to the default Object#asType:
  - BigDecimal
  - BigInteger
  - Double
  - Float

Parameters:
  `c` - the desired type of the transformed result.

Returns:
  an instance of the given type

Since:
  1.0

### compareTo

    public int compareTo(Character right)

  Compare a Number and a Character. The ordinal value of the Character is used in the comparison (the ordinal value is the unicode value which for simple character sets is the ASCII value).

Parameters:
  `right` - a Character.

Returns:
  the result of the comparison

Since:
  1.0

### compareTo

    public int compareTo(Number right)

  Compare two Numbers. Equality (==) for numbers dispatches to this.

Parameters:
  `right` - another Number to compare to.

Returns:
  the comparision of both numbers

Since:
  1.0

### div

    public Number div(Character right)

  Divide a Number by a Character. The ordinal value of the Character is used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).

Parameters:
  `right` - a Character.

Returns:
  the Number corresponding to the division of left by right

Since:
  1.0

### div

    public Number div(Number right)

  Divide two Numbers. Note: Method name different from 'divide' to avoid collision with BigInteger method that has different semantics. We want a BigDecimal result rather than a BigInteger.

Parameters:
  `right` - another Number.

Returns:
  a Number resulting of the divide operation

### downto

    public void downto(Number to, Closure closure)

  Iterates from this number down to the given number, inclusive, decrementing by one each time.

Parameters:
  `to` - another Number to go down to.
  `closure` - the closure to call.

Since:
  1.0

### intdiv

    public Number intdiv(Character right)

  Integer Divide a Number by a Character. The ordinal value of the Character is used in the division (the ordinal value is the unicode value which for simple character sets is the ASCII value).

Parameters:
  `right` - a Character.

Returns:
  a Number (an Integer) resulting from the integer division operation

Since:
  1.0

### intdiv

    public Number intdiv(Number right)

  Integer Divide two Numbers.

Parameters:
  `right` - another Number.

Returns:
  a Number (an Integer) resulting from the integer division operation

Since:
  1.0

### isCase

    public boolean isCase(Number switchValue)

  Special 'case' implementation for all numbers, which delegates to the `compareTo()` method for comparing numbers of different types.

Parameters:
  `switchValue` - the switch value.

Returns:
  true if the numbers are deemed equal

Since:
  1.5.0

### leftShift

    public Number leftShift(Number operand)

  Implementation of the left shift operator for integral types. Non integral Number types throw UnsupportedOperationException.

Parameters:
  `operand` - the shift distance by which to left shift the number.

Returns:
  the resulting number

Since:
  1.5.0

### minus

    public Number minus(Character right)

  Subtract a Character from a Number. The ordinal value of the Character is used in the subtraction (the ordinal value is the unicode value which for simple character sets is the ASCII value).

Parameters:
  `right` - a Character.

Returns:
  the Number corresponding to the subtraction of right from left

Since:
  1.0

### minus

    public Number minus(Number right)

  Substraction of two Numbers.

Parameters:
  `right` - another Number to substract to the first one.

Returns:
  the substraction

### mod

    public Number mod(Number right)

  Performs a division modulus operation. Called by the '%' operator.

Parameters:
  `right` - another Number to mod.

Returns:
  the modulus result

Since:
  1.0

### multiply

    public Number multiply(Character right)

  Multiply a Number by a Character. The ordinal value of the Character is used in the multiplication (the ordinal value is the unicode value which for simple character sets is the ASCII value).

Parameters:
  `right` - a Character.

Returns:
  the multiplication of left by right

Since:
  1.0

### multiply

    public Number multiply(Number right)

  Multiply two Numbers.

Parameters:
  `right` - another Number.

Returns:
  the multiplication of both

### next

    public Number next()

  Increment a Number by one.

Returns:
  an incremented Number

Since:
  1.0

### or

    public Number or(Number right)

  Bitwise OR together two numbers.

Parameters:
  `right` - another Number to bitwise OR.

Returns:
  the bitwise OR of both Numbers

Since:
  1.0

### plus

    public String plus(String right)

  Appends a String to the string representation of this number.

Parameters:
  `right` - a String.

Returns:
  a String

Since:
  1.0

### plus

    public Number plus(Character right)

  Add a Number and a Character. The ordinal value of the Character is used in the addition (the ordinal value is the unicode value which for simple character sets is the ASCII value).

Parameters:
  `right` - a Character.

Returns:
  The Number corresponding to the addition of left and right

Since:
  1.0

See:
  Integer#valueOf.

### plus

    public Number plus(Number right)

  Add two numbers and return the result.

Parameters:
  `right` - another Number to add.

Returns:
  the addition of both Numbers

### power

    public Number power(Number exponent)

  Power of a Number to a certain exponent. Called by the '**' operator.

Parameters:
  `exponent` - a Number exponent.

Returns:
  a Number to the power of a certain exponent

Since:
  1.0

### previous

    public Number previous()

  Decrement a Number by one.

Returns:
  a decremented Number

Since:
  1.0

### rightShift

    public Number rightShift(Number operand)

  Implementation of the right shift operator for integral types. Non integral Number types throw UnsupportedOperationException.

Parameters:
  `operand` - the shift distance by which to right shift the number.

Returns:
  the resulting number

Since:
  1.5.0

### rightShiftUnsigned

    public Number rightShiftUnsigned(Number operand)

  Implementation of the right shift (unsigned) operator for integral types. Non integral Number types throw UnsupportedOperationException.

Parameters:
  `operand` - the shift distance by which to right shift (unsigned) the number.

Returns:
  the resulting number

Since:
  1.5.0

### step

    public void step(Number to, Number stepNumber, Closure closure)

  Iterates from this number up to the given number using a step increment. Each intermediate number is passed to the given closure. Example:

      0.step( 10, 2 ) {
        println it
      }

  Prints even numbers 0 through 8.

Parameters:
  `to` - a Number to go up to, exclusive.
  `stepNumber` - a Number representing the step increment.
  `closure` - the closure to call.

Since:
  1.0

### times

    public void times(Closure closure)

  Executes the closure this many times, starting from zero. The current index is passed to the closure each time. Example:

      10.times {
        println it
      }

  Prints the numbers 0 through 9.

Parameters:
  `closure` - the closure to call a number of times.

Since:
  1.0

### toBigDecimal

    public BigDecimal toBigDecimal()

  Transform a Number into a BigDecimal

Returns:
  an BigDecimal

Since:
  1.0

### toBigInteger

    public BigInteger toBigInteger()

  Transform this Number into a BigInteger.

Returns:
  an BigInteger

Since:
  1.0

### toDouble

    public Double toDouble()

  Transform a Number into a Double

Returns:
  an Double

Since:
  1.0

### toFloat

    public Float toFloat()

  Transform a Number into a Float

Returns:
  an Float

Since:
  1.0

### toInteger

    public Integer toInteger()

  Transform a Number into an Integer

Returns:
  an Integer

Since:
  1.0

### toLong

    public Long toLong()

  Transform a Number into a Long

Returns:
  an Long

Since:
  1.0

### unaryMinus

    public Number unaryMinus()

  Negates the number. Equivalent to the '-' operator when it preceeds a single operand, i.e. `-10`

Returns:
  the negation of the number

Since:
  1.5.0

### upto

    public void upto(Number to, Closure closure)

  Iterates from this number up to the given number, inclusive, incrementing by one each time.

Parameters:
  `to` - another Number to go up to.
  `closure` - the closure to call.

Since:
  1.0

### xor

    public Number xor(Number right)

  Bitwise XOR together two Numbers. Called when the '|' operator is used.

Parameters:
  `right` - another Number to bitwse XOR.

Returns:
  the bitwise XOR of both Numbers

Since:
  1.0

Overview | Package | Class | Tree | Deprecated | Index | Help
| Groovy JDK