org.apache.poi.ss.formula.functions.Oct2Dec Maven / Gradle / Ivy
Show all versions of poi Show documentation
/* ====================================================================
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
==================================================================== */
package org.apache.poi.ss.formula.functions;
import org.apache.poi.ss.formula.OperationEvaluationContext;
import org.apache.poi.ss.formula.eval.ErrorEval;
import org.apache.poi.ss.formula.eval.NumberEval;
import org.apache.poi.ss.formula.eval.OperandResolver;
import org.apache.poi.ss.formula.eval.ValueEval;
/**
* Implementation for Excel Oct2Dec() function.
*
* Converts an octal number to decimal.
*
*
* Syntax:
Oct2Dec (number )
*
*
* Number is the octal number you want to convert. Number may not contain more than 10 octal characters (30 bits).
* The most significant bit of number is the sign bit. The remaining 29 bits are magnitude bits.
* Negative numbers are represented using two's-complement notation..
*
* If number is not a valid octal number, OCT2DEC returns the #NUM! error value.
*
* @author cedric dot walter @ gmail dot com
*/
public class Oct2Dec extends Fixed1ArgFunction implements FreeRefFunction {
public static final FreeRefFunction instance = new Oct2Dec();
static final int MAX_NUMBER_OF_PLACES = 10;
static final int OCTAL_BASE = 8;
public ValueEval evaluate(int srcRowIndex, int srcColumnIndex, ValueEval numberVE) {
String octal = OperandResolver.coerceValueToString(numberVE);
try {
return new NumberEval(BaseNumberUtils.convertToDecimal(octal, OCTAL_BASE, MAX_NUMBER_OF_PLACES));
} catch (IllegalArgumentException e) {
return ErrorEval.NUM_ERROR;
}
}
public ValueEval evaluate(ValueEval[] args, OperationEvaluationContext ec) {
if (args.length != 1) {
return ErrorEval.VALUE_INVALID;
}
return evaluate(ec.getRowIndex(), ec.getColumnIndex(), args[0]);
}
}