All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.objectspace.jgl.functions.ModulusNumber

java.lang.Object
   |
   +----com.objectspace.jgl.functions.ModulusNumber

public final class ModulusNumber

extends Object

implements BinaryFunction

See Also:

Number, BigInteger, BigDecimal

ModulusNumber()

Construct myself to use intValue() for operation.

ModulusNumber(Class)

Construct myself to operate on objects of the given class.

ModulusNumber(Class, int)

Construct myself to operate on objects of the given class.

execute(Object, Object)

Return the result of the first operand modulus the second operand.

 public ModulusNumber()

Construct myself to use intValue() for operation.

 public ModulusNumber(Class discriminator)

Construct myself to operate on objects of the given class. The class must be derived from java.lang.Number. If the discriminating class is java.math.BigDecimal, use ROUND_DOWN as the rounding mode.

Parameters:

discriminator - The class of objects on which I will be operating.

Throws: IllegalArgumentException

Throw if discriminator is not an instance of java.lang.Number.

See Also:

BigDecimal

 public ModulusNumber(Class discriminator,
                      int rounding)

Construct myself to operate on objects of the given class. The class must be derived from java.lang.Number. If the class is an instance of java.math.BigDecimal, use the given rounding mode.

Parameters:

discriminator - The class of objects on which I will be operating.

rounding - The specified rounding mode. Only used when the discriminator is a java.math.BigDecimal.

Throws: IllegalArgumentException

Throw if discriminator is not an instance of java.lang.Number.

See Also:

divide

 public Object execute(Object first,
                       Object second)

Return the result of the first operand modulus the second operand. Be aware that some floating point conversions are not exact, and may cause unexpected results due to rounding.

Parameters:

first - The first operand, which must be an instance of Number.

second - The second operand, which must be an instance of Number.

Returns:

first / second

Throws: InvalidOperationException

Throw if I don't know how to interpret the values.

All Packages  Class Hierarchy  This Package  Previous  Next  Index