org.apache.poi.ss.formula.functions
Class Dec2Hex

java.lang.Object
  extended by org.apache.poi.ss.formula.functions.Dec2Hex
All Implemented Interfaces:
FreeRefFunction, Function, Function1Arg, Function2Arg

public final class Dec2Hex
extends java.lang.Object
implements FreeRefFunction

Implementation for Excel DELTA() function.

Syntax:
DEC2HEX (number,places )

Converts a decimal number to hexadecimal. The decimal integer you want to convert. If number is negative, places is ignored and this function returns a 10-character (40-bit) hexadecimal number in which the most significant bit is the sign bit. The remaining 39 bits are magnitude bits. Negative numbers are represented using two's-complement notation.

places

The number of characters to use. The places argument is useful for padding the return value with leading 0s (zeros).


Field Summary
static FreeRefFunction instance
           
 
Constructor Summary
Dec2Hex()
           
 
Method Summary
 ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval arg0)
          see Function.evaluate(ValueEval[], int, int)
 ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval number, ValueEval places)
          see Function.evaluate(ValueEval[], int, int)
 ValueEval evaluate(ValueEval[] args, int srcRowIndex, int srcColumnIndex)
           
 ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

instance

public static final FreeRefFunction instance
Constructor Detail

Dec2Hex

public Dec2Hex()
Method Detail

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval number,
                          ValueEval places)
Description copied from interface: Function2Arg
see Function.evaluate(ValueEval[], int, int)

Specified by:
evaluate in interface Function2Arg

evaluate

public ValueEval evaluate(int srcRowIndex,
                          int srcColumnIndex,
                          ValueEval arg0)
Description copied from interface: Function1Arg
see Function.evaluate(ValueEval[], int, int)

Specified by:
evaluate in interface Function1Arg

evaluate

public ValueEval evaluate(ValueEval[] args,
                          OperationEvaluationContext ec)
Specified by:
evaluate in interface FreeRefFunction
Parameters:
args - the pre-evaluated arguments for this function. args is never null, nor are any of its elements.
ec - primarily used to identify the source cell containing the formula being evaluated. may also be used to dynamically create reference evals.
Returns:
never null. Possibly an instance of ErrorEval in the case of a specified Excel error (Exceptions are never thrown to represent Excel errors).

evaluate

public final ValueEval evaluate(ValueEval[] args,
                                int srcRowIndex,
                                int srcColumnIndex)
Specified by:
evaluate in interface Function
Parameters:
args - the evaluated function arguments. Empty values are represented with BlankEval or MissingArgEval, never null.
srcRowIndex - row index of the cell containing the formula under evaluation
srcColumnIndex - column index of the cell containing the formula under evaluation
Returns:
The evaluated result, possibly an ErrorEval, never null. Note - Excel uses the error code #NUM! instead of IEEE NaN, so when numeric functions evaluate to Double.NaN be sure to translate the result to ErrorEval.NUM_ERROR.